# Frequently Asked Questions (/faq)

import { Accordion, Accordions } from "fumadocs-ui/components/accordion";

## Getting Started

<Accordions type="multiple">
  <Accordion title="How do I create an OnlyFans API account?" id="how-do-i-create-an-onlyfans-api-account">
    Follow the steps at [app.onlyfansapi.com/register](https://app.onlyfansapi.com/register). It takes less than 1 minute.
  </Accordion>

  <Accordion title="Can I work with OnlyFans API if I'm not a developer?" id="can-i-work-with-onlyfans-api-if-im-not-a-developer">
    Yes! You can use our no-code integrations with [Make](/integrations/make), [n8n](/integrations/n8n), or [Zapier](/integrations/zapier). If you need hands-on help, email us at [hello@onlyfansapi.com](mailto:hello@onlyfansapi.com).
  </Accordion>

  <Accordion title="Do you have a sandbox or demo account for testing?" id="do-you-have-a-sandbox-or-demo-account">
    No sandbox environment is available. However, you can simply create a new account on OnlyFans.com and connect it to OnlyFans API for testing purposes.
  </Accordion>

  <Accordion title="Which programming languages can I use?" id="which-programming-languages-can-i-use">
    All of our API endpoints can be used with any programming language. Click on any endpoint in our [API Reference](/api-reference) to view code examples in cURL, JavaScript/TypeScript, Go, Python, Java, and C#.
  </Accordion>

  <Accordion title="Can I use OnlyFans API with OnlyMonster / Infloww / CreatorHero / Any other OnlyFans CRM?" id="can-i-use-onlyfans-api-with-onlymonster-infloww-creatorhero">
    Yes, absolutely. Having your account connected to OnlyFans API doesn't affect your ability to use any other OnlyFans CRM and vice versa.
  </Accordion>
</Accordions>

## API Capabilities & Features

<Accordions type="multiple">
  <Accordion title="Can your API send and read messages?" id="can-your-api-send-and-read-messages">
    Yes, our API fully supports reading and sending messages. Refer to our [List Chats](/api-reference/chats/list-chats) and [Send Message](/api-reference/chat-messages/send-message) endpoints for more details.
  </Accordion>

  <Accordion title="Is image generation supported?" id="is-image-generation-supported">
    Image generation is not natively supported at this time. However, we recommend third-party solutions like [fanscreator.ai](https://fanscreator.ai) for this functionality.
  </Accordion>

  <Accordion title="Can I upload media directly to the vault?" id="can-i-upload-media-directly-to-the-vault">
    Direct vault uploads aren't supported by OnlyFans. However, you have a few options:

    * **Recommended:** Upload media exactly when and where it needs to be posted — for example, directly to a post, message, or scheduled post — instead of preloading it into the vault. This keeps your workflow simple and avoids unnecessary steps.
    * If you still want to store media in the vault ahead of time, you can:
      * Upload media using our [OnlyFans CDN upload](/api-reference/media/upload-media-to-the-only-fans-cdn) endpoint.
      * [Create a post](/api-reference/posts/send-post) with the media, then delete it immediately - the media will remain in your vault
      * Use our [Send Message](/api-reference/chat-messages/send-message) endpoint to include the media in a message, then delete the message — again, the media will stay in your vault.
  </Accordion>

  <Accordion title="Can I integrate with Supabase or similar tools?" id="can-i-integrate-with-supabase-or-similar-tools">
    Yes! Many customers successfully use tools like [n8n](https://n8n.io) and [Supabase](https://supabase.com) for faster development and deployment.
  </Accordion>

  <Accordion title="Is there an API endpoint for scheduling chat messages?" id="is-there-an-api-endpoint-for-scheduling-chat-messages">
    Use our [Send Mass Message](/api-reference/mass-messaging/send-mass-message) endpoint. Include just one user ID in the `userIds` array to effectively schedule a message for an individual chat. This behaves exactly like the native "Scheduled Messages" feature in OnlyFans.
  </Accordion>

  <Accordion title="How do I send a PPV (pay-per-view) message?" id="how-do-i-send-a-ppv-message">
    Refer to our dedicated guide on [setting a price for PPV content](/introduction/guides/composing-messages#setting-a-price-ppv).
  </Accordion>

  <Accordion title="Can your API retrieve Golden Response Times?" id="can-your-api-retrieve-golden-response-times">
    This will be available in our upcoming Advanced Endpoints feature.
  </Accordion>

  <Accordion title="Why do I get 404 errors on your endpoints?" id="why-do-i-get-404-errors-on-your-endpoints">
    You're likely missing the account prefix.

    * ❌ Wrong: `/api/fans/active`
    * ✅ Correct: `/api/acct_XXXXXXXX/fans/active`
  </Accordion>

  <Accordion title="Which endpoint should I use to build a creator directory?" id="which-endpoint-should-i-use-to-build-a-creator-directory">
    Use our [Search Profiles](/api-reference/public-profiles/search-profiles) endpoint with the `sort` query parameter to list and sort creators. For more frequent data updates on individual creators, use [Get Profile Details](/api-reference/public-profiles/get-profile-details). You can also use our [Create Data Export](/api-reference/data-exports/create-data-export) tool for bulk exports.
  </Accordion>

  <Accordion title="Can I add text, question stickers, or emoji elements on story posts through the API?" id="can-i-add-text-question-stickers-or-emoji-elements-on-story-posts">
    Not currently. When you add text, questions, or stickers to a story on OnlyFans, the browser actually renders those elements onto the image locally using an HTML Canvas, then uploads the composed image as a separate file.

    To achieve this through the API, you would need to compose the image yourself before uploading. You can use image processing libraries to render text onto your image, then upload the result via our media upload endpoint:

    * **PHP** — GD (built-in) or Imagick
    * **Node.js** — sharp, @napi-rs/canvas, node-canvas
    * **Python** — Pillow, pyvips
    * **Ruby** — MiniMagick, ruby-vips

    Once you've composed the image with your overlays, upload it normally and use the returned `ofapi_media_` ID in your story request.
  </Accordion>
</Accordions>

## Security & Safety

<Accordions type="multiple">
  <Accordion title="Is your API safe to use?" id="is-your-api-safe-to-use">
    Yes, absolutely. We have a 5-year track record with:

    * Zero accounts banned
    * Zero accounts red-flagged
    * Enterprise-grade security measures
  </Accordion>

  <Accordion title="Can I get banned for using the OnlyFans API as a chatbot?" id="can-i-get-banned-for-using-the-api-as-a-chatbot">
    No. We have a track record of zero account bans over the past 5 years, including many customers using OnlyFans API to build chatbots.
  </Accordion>

  <Accordion title="How are login credentials protected?" id="how-are-login-credentials-protected">
    Your security is our priority:

    * All passwords and cookies are hashed in our database
    * We use OpenSSL with AES-256-CBC encryption
    * All data is signed with MAC (Message Authentication Code)
  </Accordion>

  <Accordion title="How do you handle proxy configuration?" id="how-do-you-handle-proxy-configuration">
    We implement robust proxy protection:

    * Each connected account gets a dedicated IP address
    * Public endpoints use rotating residential proxies
    * This prevents detection and ensures account safety

    For more information, refer to our dedicated [proxies guide](introduction/essentials/proxies).
  </Accordion>

  <Accordion title="Does OnlyFans API store data from my connected accounts?" id="does-onlyfans-api-store-data-from-my-connected-accounts">
    No. We do not store any data from authenticated accounts on our servers. All credentials are encrypted using OpenSSL with the AES-256-CBC cipher and signed with a message authentication code (MAC) to prevent tampering.
  </Accordion>

  <Accordion title="What happens when my OnlyFans session expires?" id="what-happens-when-my-onlyfans-session-expires">
    When a session expires, we automatically attempt to re-login up to 3 times within a one-hour period. This ensures minimal disruption to your API usage without requiring any manual intervention.
  </Accordion>
</Accordions>

## API Stability & Performance

<Accordions type="multiple">
  <Accordion title="How stable is your API?" id="how-stable-is-your-api">
    Our API infrastructure includes:

    * Web Application Firewall (WAF)
    * Proxy management
    * Built-in rate limiting
    * No stability issues reported to date

    <Callout title="Please note we cannot control OnlyFans platform stability">
      Check our real-time status at: [status.onlyfansapi.com](https://status.onlyfansapi.com)
    </Callout>
  </Accordion>

  <Accordion title="What happens when OnlyFans updates their website?" id="what-happens-when-onlyfans-updates-their-website">
    Website updates have minimal impact:

    * Downtime only occurs if OnlyFans itself is down
    * We typically adapt to changes within minutes
    * No extended service interruptions
  </Accordion>

  <Accordion title="How long is the cache duration?" id="how-long-is-the-cache-duration">
    Cache duration varies per endpoint, though most endpoints are not cached. Check our [response structure guide](/introduction/essentials/response-structure) for specific cache durations.
  </Accordion>
</Accordions>

## Rate Limiting & Best Practices

<Accordions type="multiple">
  <Accordion title="How do I handle rate limiting errors?" id="how-do-i-handle-rate-limiting-errors">
    **Recommended approach:** Implement exponential backoff

    1. When you receive a 429 error, wait 1 second
    2. If it happens again, double the wait time (2s → 4s → 8s)
    3. Continue up to a maximum wait time
    4. Use queuing systems like AWS SQS, Laravel Queues, or Ruby Sidekiq

    <Callout title="Need more help?">
      Email us at [hello@onlyfansapi.com](mailto:hello@onlyfansapi.com) for code examples.
    </Callout>
  </Accordion>

  <Accordion title="Where can I find rate limit documentation?" id="where-can-i-find-rate-limit-documentation">
    Rate limits are documented in our [Rate Limits](/introduction/essentials/rate-limits) guide.
  </Accordion>
</Accordions>

## API Keys Management

<Accordions type="multiple">
  <Accordion title="How many API keys should I create?" id="how-many-api-keys-should-i-create">
    **Best practice:** One API key per service/integration

    * Create separate keys for different features
    * Assign dedicated keys to external developers
    * This improves security and tracking
  </Accordion>

  <Accordion title="Is there a limit on how many API key I can create?" id="is-there-a-limit-on-how-many-api-key-i-can-create">
    No, you can create as many API keys as you want, regardless of your subscription plan.
  </Accordion>

  <Accordion title="Can one API key access multiple endpoints?" id="can-one-api-key-access-multiple-endpoints">
    Yes, a single API key can access all available endpoints.
  </Accordion>

  <Accordion title="Are there specific scopes or permissions required for API keys?" id="are-there-specific-scopes-or-permissions-required">
    No. Every API key has full access to every account you've connected to OnlyFans API, including every endpoint.
  </Accordion>
</Accordions>

## Account Authentication & Management

<Accordions type="multiple">
  <Accordion title="Where do I find my account ID?" id="where-do-i-find-my-account-id">
    **Through our [Console](https://app.onlyfansapi.com):**

    1. Go to Dashboard -> Accounts
    2. Find the relevant account
    3. Click on the Account ID to copy it

    **Through our API:**

    1. Call our [List Accounts](/api-reference/account/list-accounts) endpoint
    2. The response includes the account ID in the `id` field

    <Callout className="pb-">
      OnlyFans API account IDs **always** start with `acct_`
    </Callout>
  </Accordion>

  <Accordion title="What's the correct format for {account} IDs in API calls?" id="whats-the-correct-format-for-account-ids-in-api-calls">
    Always use the format: `acct_XXXXXXXX`

    * Include the `acct_` prefix
    * Endpoint URL example: `https://app.onlyfansapi.com/api/acct_abc123/chats`
  </Accordion>

  <Accordion title="Can I create a platform for users to manage their accounts?" id="can-i-create-a-platform-for-users-to-manage-their-accounts">
    Yes! Use these endpoints for authentication:

    * [Start Authentication](/api-reference/connect-onlyfans-account/start-authentication)
    * [Poll Authentication Status](/api-reference/connect-onlyfans-account/poll-authentication-status)
    * Optionally, [Submit 2FA](/api-reference/connect-onlyfans-account/submit2fa)

    <Callout title="All done?" type="success">
      Use our [Get Current Account](/api-reference/account/get-current-account) endpoint to retrieve the authenticated account details.
    </Callout>

    No need to use our UI - integrate these endpoints directly with your platform.
  </Accordion>

  <Accordion title="Can I connect an OnlyFans account through the API?" id="can-i-connect-an-onlyfans-account-through-the-api">
    Yes! Use our [Start Authentication](/api-reference/connect-onlyfans-account/start-authentication) endpoint. We also have an authentication library available on NPM — see our [Login with OnlyFans documentation](/auth).
  </Accordion>

  <Accordion title="How to export cookies to authenticate an account?" id="how-to-export-cookies-to-authenticate">
    Follow the "Option 2: By providing cURL request" step in our [connect OnlyFans account guide](/introduction/guides/connect-onlyfans-account#option-2-by-providing-curl-request).
  </Accordion>

  <Accordion title="Can I retrieve the user agent used for authentication?" id="can-i-retrieve-the-user-agent">
    It is currently not possible to retrieve the user agent that OnlyFans API uses to make requests.
  </Accordion>

  <Accordion title="Is there a way to speed up the authentication process?" id="is-there-a-way-to-speed-up-authentication">
    Unfortunately, no — not without risking a red-flag from OnlyFans. Our authentication process is already optimized to be as fast as possible while maintaining safety.
  </Accordion>

  <Accordion title="How does face verification work?" id="how-does-face-verification-work">
    The experience is nearly identical to OnlyFans' native process:

    1. The QR code that the model normally scans during OF login will appear in our dashboard and via email (sent to both the OnlyFans API user and the model)
    2. After scanning the code and completing the selfie check, the account will be authenticated
  </Accordion>

  <Accordion title="I have the same OnlyFans account connected multiple times. What am I doing wrong?" id="same-account-connected-multiple-times">
    You're probably adding the account again instead of re-connecting it. Use the [Re-authenticate Account](/api-reference/connect-onlyfans-account/re-authenticate-account) endpoint instead of [Start Authentication](/api-reference/connect-onlyfans-account/start-authentication).
  </Accordion>

  <Accordion title="Is there an endpoint to list all connected creators?" id="is-there-an-endpoint-to-list-all-connected-creators">
    Yes! Use our [List Accounts](/api-reference/account/list-accounts) endpoint.
  </Accordion>

  <Accordion title="How can I see how many subscribers I have?" id="how-can-i-see-how-many-subscribers-i-have">
    You can retrieve this through:

    * The [Get Current Account](/api-reference/account/get-current-account) endpoint under `subscribersCount`
    * Or the [List User Lists](/api-reference/user-list-collections/list-user-lists) endpoint under `fans.usersCount`
  </Accordion>

  <Accordion title="How can I see my OnlyFans creator ranking?" id="how-can-i-see-my-onlyfans-creator-ranking">
    The "top X percentage of all creators" value can be retrieved through:

    * [Get Top Percentage](/api-reference/account/get-top-percentage) endpoint
    * Or [Get Current Account](/api-reference/account/get-current-account) under `performerTop`
  </Accordion>

  <Accordion title="How can I add a team member?" id="how-can-i-add-a-team-member">
    Go to our dashboard at [app.onlyfansapi.com](https://app.onlyfansapi.com) and click on "Invite & manage members" in the sidebar.
  </Accordion>
</Accordions>

## Fan Data & Analytics

<Accordions type="multiple">
  <Accordion title="Why do I sometimes get empty fan data?" id="why-do-i-sometimes-get-null-fan-data">
    This is normal behavior:

    * Chat lists return immediately
    * Fan details are scraped in the background (usually takes 2-3 seconds)

    <Callout title="Solution:" type="success">
      Either call our [Get User Details](/api-reference/users/get-user-details) endpoint, or retry the original endpoint after 10 seconds.
    </Callout>
  </Accordion>

  <Accordion title="How can I check if a fan is online?" id="how-can-i-check-if-a-fan-is-online">
    Use the lastSeen field from our [Get Profile Details](/api-reference/public-profiles/get-profile-details) or [Get User Details](/api-reference/users/get-user-details) endpoints. If the `lastSeen` value is recent, the fan is likely online.

    ```json
    {
        "lastSeen": "2025-05-01T15:01:07+00:00"
        ...
    }
    ```

    <Callout title="Response may be cached, so data might be slightly outdated.">
      [-> Read more about caching](/introduction/essentials/response-structure#cache-control)
    </Callout>
  </Accordion>

  <Accordion title="How do I track fan subscription duration?" id="how-do-i-track-fan-subscription-duration">
    There's two options available:

    * **Calculate manually:** Use `subscribedOnData.subscribeAt` on endpoints like [List Active Fans](/api-reference/fans/list-active-fans) or [Get User Details](/api-reference/users/get-user-details).
    * **Human-readable format:** Use `subscribedOnData.duration` (e.g., "3 months")
  </Accordion>

  <Accordion title="How can I see total fan spending?" id="how-can-i-see-total-fan-spending">
    Access comprehensive spending data through these fields:

    | Field            | Description                    |
    | ---------------- | ------------------------------ |
    | `totalSumm`      | Combined total of all spending |
    | `subscribesSumm` | Total spent on subscriptions   |
    | `tipsSumm`       | Total spent on tips            |
    | `messagesSumm`   | Total spent on paid messages   |
    | `postsSumm`      | Total spent on paid posts      |
    | `streamsSumm`    | Total spent on streams         |

    <Callout title="Useful endpoints:">
      * [Get User Details](/api-reference/users/get-user-details)
      * [List Active Fans](/api-reference/fans/list-active-fans)
    </Callout>
  </Accordion>

  <Accordion title="How can I get a list of subscribers with spending > 0?" id="how-can-i-get-list-of-subscribers-with-spending">
    Filter by fan spendings in our [List Active Fans](/api-reference/fans/list-active-fans), [List All Fans](/api-reference/fans/list-all-fans), and [List Expired Fans](/api-reference/fans/list-expired-fans) endpoints by adding `filter.total_spent` to the query parameters. You can even filter by minimum tips.
  </Accordion>

  <Accordion title="How can I filter users by subscriber count?" id="how-can-i-filter-users-by-subscriber-count">
    Use our [Search Profiles](/api-reference/public-profiles/search-profiles) endpoint with the `sort` query parameter set to `subscribers`.
  </Accordion>

  <Accordion title="How can I see my user following count?" id="how-can-i-see-my-user-following-count">
    Retrieve it through the [List User Lists](/api-reference/user-list-collections/list-user-lists) endpoint under `following.usersCount`.
  </Accordion>

  <Accordion title="How can I see fans with rebill enabled?" id="how-can-i-see-fans-with-rebill-enabled">
    Use the [Get User List](/api-reference/user-list-collections/get-user-list) endpoint with `rebill_on` as the `{userListId}`.
  </Accordion>

  <Accordion title="How can I calculate the percentage of fans with rebill enabled?" id="how-can-i-calculate-percentage-of-fans-with-rebill">
    Call the [List User Lists](/api-reference/user-list-collections/list-user-lists) endpoint and calculate the difference between `rebill_on.usersCount` and `rebill_off.usersCount`.
  </Accordion>

  <Accordion title="How can I change a fan's nickname?" id="how-can-i-change-a-fans-nickname">
    Use our [Set Fan's Custom Name](/api-reference/fans/set-fans-custom-name) endpoint.
  </Accordion>

  <Accordion title="Can I detect a fan's language preference?" id="can-i-detect-a-fans-language-preference">
    Sadly, OnlyFans doesn't store language preferences. Workaround:

    1. Fetch chat messages from the fan
    2. Use a third-party language detection API
    3. Store the detected language in your database
  </Accordion>

  <Accordion title="How do I see what content a fan has purchased?" id="how-do-i-see-what-content-a-fan-has-purchased">
    No direct endpoint exists, but you can:

    1. Retrieve chat messages using the [List ChatMessage](/api-reference/chat-messages/list-chat-messages) endpoint
    2. Check if `isOpened = true` AND `price > 0`, which indicates a purchased PPV
  </Accordion>

  <Accordion title="Does the OnlyFans API allow scraping of subscriber data?" id="does-the-api-allow-scraping-of-subscriber-data">
    Yes. Any data that you can retrieve through our API endpoints, you can programmatically scrape.
  </Accordion>

  <Accordion title="How can I get the account ID of a user from the chats endpoint?" id="how-can-i-get-account-id-from-chats-endpoint">
    `data.fan.id` is the OnlyFans User ID of the fan, which you can also use to get the chat's messages in the [List Chat Messages](/api-reference/chat-messages/list-chat-messages) endpoint.
  </Accordion>

  <Accordion title="Where can I find the chat_id for getting chat messages?" id="where-can-i-find-the-chat-id">
    Use our [List Chats](/api-reference/chats/list-chats) endpoint, where `data.fan.id` is the `chat_id` you need for the [List Chat Messages](/api-reference/chat-messages/list-chat-messages) endpoint.
  </Accordion>

  <Accordion title="How can I delete several users from a list with a single request?" id="how-can-i-delete-several-users-from-a-list">
    Currently, OnlyFans API doesn't support removing multiple users from a list in a single request. You have two options:

    1. Clear the entire list using [Clear User List](/api-reference/user-list-collections/clear-user-list)
    2. Send one DELETE request per user via [Remove User from a User List](/api-reference/user-list-collections/remove-user-from-a-user-list)
  </Accordion>

  <Accordion title="How can I tell if a fan has read my message?" id="how-can-i-tell-if-a-fan-has-read-my-message">
    Use the `isNew` field from the [List Chat Messages](/api-reference/chat-messages/list-chat-messages) endpoint:

    * `isNew: true` — the message has **not** been seen yet
    * `isNew: false` — the fan has read the message

    <Callout>
      A real-time read-receipt webhook is not available, as OnlyFans does not expose message-read events in real time. Polling the `isNew` field is the recommended workaround.
    </Callout>
  </Accordion>
</Accordions>

## Webhooks & Media Handling

<Accordions type="multiple">
  <Accordion title="How do webhooks work?" id="how-do-webhooks-work">
    * 📚 Documentation: [docs.onlyfansapi.com/webhooks](/webhooks)
    * 🎥 Video Demo: [cap.so/s/p2wfkj072yt2x96](https://cap.so/s/p2wfkj072yt2x96)
  </Accordion>

  <Accordion title="Why do media in webhooks have no URL?" id="why-do-media-in-webhooks-have-no-url">
    When `"isReady": false`, the media is still processing.

    **Solution:**

    1. Get the chat ID from the webhook
    2. Poll the [List ChatMessage](/api-reference/chat-messages/list-chat-messages) endpoint every 10-20 seconds
    3. Wait for `"isReady": true`
    4. The URL will then be available

    **Alternatively:** Download and store vault content internally for reverse searching by media ID, once the media is ready.
  </Accordion>

  <Accordion title="Can I use webhooks with no-code tools?" id="can-i-use-webhooks-with-no-code-tools">
    Yes, you can use webhooks with no-code tools like Make, n8n or Zapier. Just set up a webhook listener in your tool and configure it to receive data from our API.

    <Callout title="Want to get started in no time?">
      We have most webhook events available as Make and Zapier modules, which you can find in our [Make](/integrations/make/available-modules#instant-triggers) and [Zapier](/integrations/zapier/available-modules#instant-triggers) directories.
    </Callout>
  </Accordion>

  <Accordion title="How can I view the logs of my webhook connection?" id="how-can-i-view-webhook-logs">
    Click on the webhook in your dashboard. It will take you to a details page where you can view all events that have recently been sent to your webhook URL.
  </Accordion>

  <Accordion title="Is there a users.stopped_typing webhook event?" id="is-there-a-users-stopped-typing-event">
    No. Here's how OnlyFans handles typing indicators:

    * When `users.typing` is received, OnlyFans shows a typing indicator for exactly 5 seconds
    * If a user continues typing, consecutive `users.typing` events are sent every \~3 seconds, resetting the timer
    * If no new `users.typing` event is received after 5 seconds, the indicator is hidden
    * If a `messages.received` event is received while the indicator is active, it is hidden

    You can replicate this logic in your own UI. You may need to adjust the timing slightly due to webhook delivery delays.
  </Accordion>

  <Accordion title="Why am I receiving a webhook event multiple times?" id="why-am-i-receiving-webhook-events-multiple-times">
    We use **at-least-once delivery semantics** for webhooks. If your server doesn't respond within **15 seconds**, the event will be retried up to 5 times with exponential backoff.

    **Best practices:**

    * Return a 2xx status code as quickly as possible, then handle logic asynchronously
    * Implement **idempotency** by deduplicating events based on their unique `event_id`
    * Check the "Attempts" column in the dashboard to confirm if retries are occurring
  </Accordion>

  <Accordion title="Is there a webhook for follower events?" id="is-there-a-webhook-for-follower-events">
    OnlyFans uses the term "follow" when a user subscribes to a free account. There is no separate "follow" action — it's the same as subscribing, just with a $0 price.
    To get notified about new followers, use the [subscriptions webhooks](/webhooks/available-events#subscriptions) (e.g. `subscriptions.new`). These fire for both paid and free subscriptions.
  </Accordion>

  <Accordion title="Is there a webhook for message read receipts?" id="is-there-a-webhook-for-message-read-receipts">
    No. OnlyFans does not expose message-read events in real time — even their own UI only updates read indicators on page refresh, not via websockets.

    **Workaround:** Poll the `isNew` field on the [List Chat Messages](/api-reference/chat-messages/list-chat-messages) endpoint. When `isNew` changes from `true` to `false`, the fan has read the message.
  </Accordion>
</Accordions>

## Media & Downloads

<Accordions type="multiple">
  <Accordion title="I cannot access a cdn*.onlyfans.com URL" id="cannot-access-cdn-onlyfans-url">
    `cdn*.onlyfans.com` URLs cannot be accessed directly due to OnlyFans' security — they are tied to specific IPs (in this case, our proxy IP). Use our [Download Media from the OnlyFans CDN](/api-reference/media/download-media-from-the-only-fans-cdn) endpoint to successfully download media files.
  </Accordion>

  <Accordion title="What do I do when downloading a media file returns a 403 error?" id="what-to-do-when-media-download-returns-403">
    When a 403 occurs:

    1. Call the endpoint again that you retrieved the `cdn*.onlyfans.com` URL from
    2. Call the download endpoint again with the newly retrieved CDN URL

    **Important checks:**

    * Always use the **same Account ID** for both retrieving and downloading. For example, if you got the URL from `/api/acct_ABC123/chats/123/messages`, you must use `acct_ABC123` in your download request
    * Use the CDN URL immediately — don't wait longer than 1 minute, as CDN URLs expire quickly
  </Accordion>

  <Accordion title="Are there content restrictions for downloading media?" id="are-there-content-restrictions-for-downloading">
    No distinction between public vs. premium or owned vs. subscribed content. The only limitation is that the authenticated account must have access to view the media file on OnlyFans.
  </Accordion>

  <Accordion title="Does the media download endpoint require a specific account type?" id="does-media-download-require-specific-account-type">
    No. Any account type can download media as long as the authenticated account has access to view the media file.
  </Accordion>

  <Accordion title="My media file's files.full.url is null. Why?" id="my-media-files-full-url-is-null">
    This happens when `convertedToVideo` is set to `false`. The file is still being converted. Once the conversion completes and the status changes to `true`, you'll be able to download the video successfully.
  </Accordion>

  <Accordion title="Which OnlyFans user's content can I view?" id="which-onlyfans-users-content-can-i-view">
    You can only view content that is accessible to the connected account — either your own content (if it's a creator account) or content from creators the account is subscribed to.

    **TL;DR:** Through our API, you can view all content you can also see when logging into onlyfans.com. Our API does not bypass any subscription or PPV pricing.
  </Accordion>
</Accordions>

## Tracking & Free Trial Links

<Accordions type="multiple">
  <Accordion title="Is there a dashboard for tracking link data?" id="is-there-a-dashboard-for-tracking-links">
    Yes! In our dashboard at [app.onlyfansapi.com](https://app.onlyfansapi.com), click on "Trial & Tracking Links" in the sidebar. You'll see an overview with clicks, subscribers, revenue, spender count, ARPS, creation date, and expiration date.

    You can also create links and generate shareable URLs with optional revenue visibility.

    <Callout>
      For calculation logic details, see our [Free Trial Links documentation](/api-reference/free-trial-links).
    </Callout>
  </Accordion>

  <Accordion title="Are there limits on how many free trial or tracking links I can create?" id="are-there-limits-on-free-trial-or-tracking-links">
    No limits! We've created hundreds to thousands of links per day via our API with no restrictions:

    * 🎁 Free Trials: No limit per day
    * 🔗 Tracking Links: No limit per day
  </Accordion>

  <Accordion title="Why do my tracking link revenue totals differ from other tools?" id="why-do-my-tracking-link-revenue-totals-differ">
    Different services calculate tracking and free trial link revenue differently, since OnlyFans doesn't provide this data natively. Some discrepancies between tools (e.g., Infloww, FansMetrics) are expected and normal.

    We are continuously improving our calculation logic to be as accurate as possible.
  </Accordion>
</Accordions>

## API Troubleshooting

<Accordions type="multiple">
  <Accordion title="My API requests are failing with 401. Why?" id="my-api-requests-are-failing-with-401">
    A 401 error indicates an authorization problem — usually an invalid API key. Verify that:

    * Your API key is correct
    * The authorization header is set up correctly in your request

    Check your API key status at [app.onlyfansapi.com/api-keys](https://app.onlyfansapi.com/api-keys).
  </Accordion>

  <Accordion title="What does a 405 error code mean?" id="what-does-a-405-error-code-mean">
    You're using the wrong HTTP method. Check our [API Reference](/api-reference) to see which HTTP method (GET, POST, DELETE, etc.) is required for the endpoint.
  </Accordion>

  <Accordion title="What does a 404 error code mean?" id="what-does-a-404-error-code-mean">
    The API URL doesn't exist. This usually means:

    * You're missing the account prefix (use `/api/acct_XXXXXXXX/...`)
    * The endpoint URL is incorrect

    Check our [API Reference](/api-reference) for valid endpoint URLs.
  </Accordion>

  <Accordion title="My API call is failing with 'Failed to fetch' or 'ERR_NAME_NOT_RESOLVED'" id="api-call-failing-with-failed-to-fetch">
    Double-check that the URL has the correct parameters and there are no network issues on your side.
  </Accordion>

  <Accordion title="How can I see which API calls returned an error?" id="how-can-i-see-which-api-calls-returned-an-error">
    In our dashboard, click on "Logs" in the sidebar to see an overview of all requests and any errors. Click on a specific request to view the full details and response.
  </Accordion>

  <Accordion title="What does a 400 error or 'Input contains restricted words' mean?" id="what-does-a-400-error-or-restricted-words-mean">
    A `400 Bad Request` with the message "Input contains restricted words" is an error returned by OnlyFans itself — not by our API. It means your message contains words that OnlyFans has blocked.

    Review your message content and remove or rephrase any terms that may be flagged. The error response includes a `textHighLight` field showing which part of your message triggered the restriction.
  </Accordion>
</Accordions>

## Billing & Subscriptions

<Accordions type="multiple">
  <Accordion title="What subscription plans are available?" id="what-subscription-plans-are-available">
    All of our subscription plans, account pricing, and credit pricing are explained at [onlyfansapi.com/pricing](https://onlyfansapi.com/pricing).
  </Accordion>

  <Accordion title="How long can I use OnlyFans API for free?" id="how-long-can-i-use-onlyfans-api-for-free">
    For as long as you want, until you've consumed all of your 10 free credits. Afterwards, you'll need to subscribe to a plan.
  </Accordion>

  <Accordion title="What is the estimated cost for the Enterprise plan?" id="what-is-the-estimated-cost-for-enterprise">
    Pricing depends on your needs — the more accounts or credits you need, the better our pricing. Schedule a call at [cal.com/onlyfansapi/15min](https://cal.com/onlyfansapi/15min).
  </Accordion>

  <Accordion title="I need more than 5 accounts connected. How do I change this limit?" id="i-need-more-than-5-accounts-connected">
    We offer dynamic pricing for additional accounts, explained at [onlyfansapi.com/pricing](https://onlyfansapi.com/pricing). You can also pre-purchase account seats.
  </Accordion>

  <Accordion title="What plan do I have?" id="what-plan-do-i-have">
    View and change your current plan at [app.onlyfansapi.com/billing](https://app.onlyfansapi.com/billing).
  </Accordion>

  <Accordion title="How can I pause or cancel my subscription?" id="how-can-i-pause-or-cancel-my-subscription">
    You currently cannot pause your subscription. To cancel, go to [app.onlyfansapi.com/billing](https://app.onlyfansapi.com/billing).
  </Accordion>
</Accordions>

## Documentation & Resources

<Accordions type="multiple">
  <Accordion title="Do you have a full OpenAPI Schema available?" id="do-you-have-a-full-openapi-schema">
    Yes! Our OpenAPI schema is available at [app.onlyfansapi.com/scribe-docs/openapi.yaml](https://app.onlyfansapi.com/scribe-docs/openapi.yaml).
  </Accordion>

  <Accordion title="Is there an endpoint that shows all available endpoints?" id="is-there-an-endpoint-that-shows-all-endpoints">
    No. Please refer to our [API Reference](/api-reference) for a complete list of available endpoints.
  </Accordion>

  <Accordion title="Do you have documentation that AI/ChatGPT can read?" id="do-you-have-documentation-for-ai">
    Yes! Visit [docs.onlyfansapi.com/llms.txt](https://docs.onlyfansapi.com/llms.txt) for the canonical AI-friendly version of our documentation. We also keep [docs.onlyfansapi.com/llms-full.txt](https://docs.onlyfansapi.com/llms-full.txt) for backward compatibility.
  </Accordion>
</Accordions>

# API Reference (/api-reference)

import { SiOnlyfans } from "@icons-pack/react-simple-icons";
import { FanslyIcon } from "@/components/fansly-icon";

## Pick your platform

We currently offer two API surfaces. Choose the one you're building against to explore its endpoints.

<Cards>
  <Card icon={<SiOnlyfans />} href="/api-reference/overview" title="OnlyFans API">
    Our most popular API with 350+ endpoints covering messaging, fans, media, payouts, posts, and more.
  </Card>

  <Card icon={<FanslyIcon />} href="/api-reference/fansly" title="Fansly API">
    Our brand-new Fansly API, currently in closed beta with a public launch coming soon.
  </Card>
</Cards>

# Login with OnlyFans (/auth)

import { Card, Cards } from "fumadocs-ui/components/card";
import {
    ShieldCheckIcon,
    ZapIcon,
    CodeIcon,
    MonitorSmartphoneIcon,
    FeatherIcon,
    HeartHandshakeIcon,
    DownloadIcon, RocketIcon
} from "lucide-react";
import {SiNextdotjs, SiTypescript} from "@icons-pack/react-simple-icons";

<span className="text-2xl font-semibold">
  @onlyfansapi/auth - Official Authentication Library
</span>

The official authentication library for OnlyFans API provides a seamless, secure way to authenticate users with their OnlyFans accounts directly from your application.

## Features

<Cards className="grid grid-cols-3 gap-4 @container">
  <Card icon={<ShieldCheckIcon className="text-fd-primary" />} title="Secure & Responsive">
    Built with enterprise-grade security and works seamlessly on both desktop and mobile devices.
  </Card>

  <Card icon={<ZapIcon className="text-fd-primary" />} title="Lightning Fast">
    1.5kB script loads in just 2ms on 4G internet, ensuring your users never wait for authentication.
  </Card>

  <Card icon={<CodeIcon className="text-fd-primary" />} title="Developer Experience">
    Developer-friendly with TypeScript support, comprehensive docs, and intuitive APIs.
  </Card>
</Cards>

## Why choose @onlyfansapi/auth?

<Cards className="grid grid-cols-3 gap-4 @container">
  <Card title="Enterprise-grade security" icon={<ShieldCheckIcon className="text-fd-primary"/>}>
    Built with industry-standard security practices to protect user credentials and authentication flows. Trusted by developers who prioritize security.
  </Card>

  <Card title="Cross-platform compatibility" icon={<MonitorSmartphoneIcon className="text-fd-primary"/>}>
    Seamlessly works across all devices—desktop, mobile, and tablet. Your users get a consistent authentication experience regardless of their platform.
  </Card>

  <Card title="Lightweight" icon={<FeatherIcon className="text-fd-primary"/>}>
    Minimal footprint at just 1.5kB ensures lightning-fast load times. Authenticate users in under 2ms even on slower 4G connections.
  </Card>

  <Card title="TypeScript support" icon={<SiTypescript size={16} color="default"/>}>
    Full TypeScript definitions included for better developer experience, type safety, and autocomplete support in your IDE.
  </Card>

  <Card title="Framework agnostic" icon={<CodeIcon className="text-fd-primary"/>}>
    Use with any framework or no framework at all. Works seamlessly with React, Vue, Svelte, Angular, and vanilla JavaScript with zero dependencies.
  </Card>

  <Card title="Developer-friendly" icon={<HeartHandshakeIcon className="text-fd-primary"/>}>
    Intuitive APIs designed for ease of use with comprehensive documentation, clear examples, and straightforward integration patterns.
  </Card>
</Cards>

## Getting started

Ready to integrate authentication into your application? Check out our installation guide and quickstart to get started in minutes.

<Cards>
  <Card href="/auth/installation" title="Installation Guide" icon={<DownloadIcon className="text-fd-primary"/>}>
    Learn how to install and set up @onlyfansapi/auth in your project.
  </Card>

  <Card href="/auth/quickstart" title="Quick Start" icon={<RocketIcon className="text-fd-primary"/>}>
    Get up and running with our auth package in just a few minutes.
  </Card>

  <Card href="/auth/examples/nextjs-prisma" title="Next.js + Prisma Example" icon={<SiNextdotjs className="text-fd-primary"/>}>
    Explore a complete example of using @onlyfansapi/auth with Next.js and Prisma.
  </Card>
</Cards>

# Installation (/auth/installation)

import { Tabs, Tab } from "fumadocs-ui/components/tabs";
import { Step, Steps } from "fumadocs-ui/components/steps";
import { Card, Cards } from "fumadocs-ui/components/card";
import { TerminalIcon } from "lucide-react";

## Package Manager

Install `@onlyfansapi/auth` using your preferred package manager:

<Tabs items={['npm', 'pnpm', 'yarn', 'bun']}>
  <Tab value="npm">
    ```bash
    npm install @onlyfansapi/auth
    ```
  </Tab>

  <Tab value="pnpm">
    ```bash
    pnpm add @onlyfansapi/auth
    ```
  </Tab>

  <Tab value="yarn">
    ```bash
    yarn add @onlyfansapi/auth
    ```
  </Tab>

  <Tab value="bun">
    ```bash
    bun add @onlyfansapi/auth
    ```
  </Tab>
</Tabs>

## Prerequisites

Before you begin, make sure you have:

<Cards>
  <Card icon={<TerminalIcon className="text-fd-primary" />} href="https://app.onlyfansapi.com" title="An OnlyFans API account">
    If you don't have one yet, registering takes just a few seconds.

    <a className="flex flex-row items-center gap-1 w-fit" href="https://app.onlyfansapi.com" target="_blank">
      » Create a free account
    </a>
  </Card>
</Cards>

## Get Your API Key

Before creating a client session token, you'll need an API key to authenticate your requests to the OnlyFans API.

<Steps>
  <Step>
    ### Go to the OnlyFans API console → API Keys

    Navigate to your [OnlyFans API console](https://app.onlyfansapi.com) and click on **API Keys** in the navigation menu.
  </Step>

  <Step>
    ### Create a new API key

    Click the **"Create API Key"** button to generate a new API key.

    Copy and save your API key securely - you'll need it to create client session tokens.
  </Step>
</Steps>

## Create Your Client Session Token

To use `@onlyfansapi/auth`, you'll need to create a client session token (starts with `ofapi_cs_`) through the [Create Client Session](/api-reference/client-sessions/create-client-session) API endpoint.

<Steps>
  <Step>
    ### Make a POST request to create a client session

    Use your API key to authenticate the request:

    ```bash
    curl -X POST "https://app.onlyfansapi.com/api/client-sessions" \
      -H "Authorization: Bearer YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "display_name": "My Application / Model: John Doe"
      }'
    ```

    **Optional fields:**

    * `client_reference_id` - Your internal reference ID for the connected account
    * `proxy_country` - Proxy country value (`"us" | "uk"`)

    <Callout type="warn">
      Other proxy countries (DE, FR, IT) have been temporarily removed due to OnlyFans restrictions. Only US and UK proxies are currently available.
    </Callout>
  </Step>

  <Step>
    ### Get the client session token from the response

    The response will include a `token` field that starts with `ofapi_cs_`:

    ```json
    {
      "data": {
        "token": "ofapi_cs_OriR8Sdocp0f97eFOdbMMZtiz4Aw5FLX",
        "display_name": "My Application / Model: John Doe"
      }
    }
    ```

    This token is what you'll use with the `@onlyfansapi/auth` package.
  </Step>

  <Step>
    ### Use the client session token

    Copy the client session token and use it in your application with `@onlyfansapi/auth`.

    **Important:** Keep your client session token secure. While it's designed for client-side use, treat it with appropriate security measures.
  </Step>
</Steps>

## Next Steps

Once you've installed the package and created your client session token, you're ready to start implementing authentication in your application.

* [Quick Start Guide](/auth/quickstart) - Get up and running in minutes
* [Create Client Session API Reference](/api-reference/client-sessions/create-client-session) - Full API documentation
* [NPM Package](https://www.npmjs.com/package/@onlyfansapi/auth) - Full package documentation on npm

# Quick Start (/auth/quickstart)

import { Tabs, Tab } from "fumadocs-ui/components/tabs";
import { Step, Steps } from "fumadocs-ui/components/steps";
import { Callout } from "fumadocs-ui/components/callout";

## Overview

This guide will walk you through implementing `@onlyfansapi/auth` in your application. The authentication library provides a simple, secure way to authenticate users with their OnlyFans accounts.

## Before You Start

<Callout type="info">
  Make sure you've completed the [installation](/auth/installation) steps first. You'll need:

  * The package installed in your project
  * An API key to create client session tokens
  * A client session token (starts with `ofapi_cs_`) to use with the library
</Callout>

## Basic Usage

The library exports a single function `startOnlyFansAuthentication` that handles the entire authentication flow. When called, it opens a secure iframe modal where users can authenticate with their OnlyFans account.

### Import

```typescript twoslash
import { startOnlyFansAuthentication } from '@onlyfansapi/auth';
```

### Function Signature

```typescript
const startOnlyFansAuthentication: (clientSessionToken: string, options: {
    onSuccess: (data: AuthSuccessData) => void;
    onError: (error: AuthFailureError) => void;
    onContinue?: () => void;
}) => void
```

**Parameters:**

* `clientSecret` (string, required): Your client session token obtained from the [Create Client Session](/api-reference/client-sessions/create-client-session) API endpoint
* `options.onSuccess` (function, required): Callback invoked when authentication succeeds
* `options.onError` (function, required): Callback invoked when authentication fails

## Framework Examples

<Tabs items={['React', 'Vue', 'Svelte', 'Angular', 'Vanilla JS']}>
  <Tab value="React">
    ```tsx
    import React, { useState } from 'react';
    import { startOnlyFansAuthentication } from '@onlyfansapi/auth';

    export default function AuthComponent() {
      const [isLoading, setIsLoading] = useState(false);
      const [authData, setAuthData] = useState(null);
      const [error, setError] = useState(null);

      const handleAuthentication = () => {
        setIsLoading(true);
        setError(null);
        
        startOnlyFansAuthentication('ofapi_cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', {
          onSuccess: (data) => {
            console.log('Authentication successful:', data);
            setAuthData(data);
            setIsLoading(false);
            // data.accountId - The authenticated account ID
            // data.username - The authenticated username
            // data.response - Full response from the API
          },
          onError: (error) => {
            console.error('Authentication failed:', error);
            setError(error);
            setIsLoading(false);
            // error.message - Error message
            // error.code - Error code (if available)
            // error.details - Additional error details (if available)
          },
        });
      };

      return (
        <div className="auth-container">
          <button 
            onClick={handleAuthentication}
            disabled={isLoading}
            className="auth-button"
          >
            {isLoading ? 'Authenticating...' : 'Connect OnlyFans Account'}
          </button>
          
          {authData && (
            <div className="success-message">
              <h3>Authentication Successful!</h3>
              <p>Account ID: {authData.accountId}</p>
              <p>Username: {authData.username}</p>
            </div>
          )}
          
          {error && (
            <div className="error-message">
              <h3>Authentication Failed</h3>
              <p>{error.message}</p>
            </div>
          )}
        </div>
      );
    }
    ```
  </Tab>

  <Tab value="Vue">
    ```vue
    <template>
      <div class="auth-container">
        <button 
          @click="handleAuthentication"
          :disabled="isLoading"
          class="auth-button"
        >
          {{ isLoading ? 'Authenticating...' : 'Connect OnlyFans Account' }}
        </button>
        
        <div v-if="authData" class="success-message">
          <h3>Authentication Successful!</h3>
          <p>Account ID: {{ authData.accountId }}</p>
          <p>Username: {{ authData.username }}</p>
        </div>
        
        <div v-if="error" class="error-message">
          <h3>Authentication Failed</h3>
          <p>{{ error.message }}</p>
        </div>
      </div>
    </template>

    <script setup>
    import { ref } from 'vue';
    import { startOnlyFansAuthentication } from '@onlyfansapi/auth';

    const isLoading = ref(false);
    const authData = ref(null);
    const error = ref(null);

    const handleAuthentication = () => {
      isLoading.value = true;
      error.value = null;
      
      startOnlyFansAuthentication('ofapi_cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', {
        onSuccess: (data) => {
          console.log('Authentication successful:', data);
          authData.value = data;
          isLoading.value = false;
        },
        onError: (err) => {
          console.error('Authentication failed:', err);
          error.value = err;
          isLoading.value = false;
        },
      });
    };
    </script>
    ```
  </Tab>

  <Tab value="Svelte">
    ```svelte
    <script>
      import { startOnlyFansAuthentication } from '@onlyfansapi/auth';

      let isLoading = false;
      let authData = null;
      let error = null;

      function handleAuthentication() {
        isLoading = true;
        error = null;
        
        startOnlyFansAuthentication('ofapi_cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', {
          onSuccess: (data) => {
            console.log('Authentication successful:', data);
            authData = data;
            isLoading = false;
          },
          onError: (err) => {
            console.error('Authentication failed:', err);
            error = err;
            isLoading = false;
          },
        });
      }
    </script>

    <div class="auth-container">
      <button 
        on:click={handleAuthentication}
        disabled={isLoading}
        class="auth-button"
      >
        {isLoading ? 'Authenticating...' : 'Connect OnlyFans Account'}
      </button>
      
      {#if authData}
        <div class="success-message">
          <h3>Authentication Successful!</h3>
          <p>Account ID: {authData.accountId}</p>
          <p>Username: {authData.username}</p>
        </div>
      {/if}
      
      {#if error}
        <div class="error-message">
          <h3>Authentication Failed</h3>
          <p>{error.message}</p>
        </div>
      {/if}
    </div>
    ```
  </Tab>

  <Tab value="Angular">
    ```typescript
    import { Component } from '@angular/core';
    import { startOnlyFansAuthentication } from '@onlyfansapi/auth';

    @Component({
      selector: 'app-auth',
      template: `
        <div class="auth-container">
          <button 
            (click)="handleAuthentication()"
            [disabled]="isLoading"
            class="auth-button"
          >
            {{ isLoading ? 'Authenticating...' : 'Connect OnlyFans Account' }}
          </button>
          
          <div *ngIf="authData" class="success-message">
            <h3>Authentication Successful!</h3>
            <p>Account ID: {{ authData.accountId }}</p>
            <p>Username: {{ authData.username }}</p>
          </div>
          
          <div *ngIf="error" class="error-message">
            <h3>Authentication Failed</h3>
            <p>{{ error.message }}</p>
          </div>
        </div>
      `
    })
    export class AuthComponent {
      isLoading = false;
      authData: any = null;
      error: any = null;

      handleAuthentication() {
        this.isLoading = true;
        this.error = null;
        
        startOnlyFansAuthentication('ofapi_cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', {
          onSuccess: (data) => {
            console.log('Authentication successful:', data);
            this.authData = data;
            this.isLoading = false;
          },
          onError: (error) => {
            console.error('Authentication failed:', error);
            this.error = error;
            this.isLoading = false;
          },
        });
      }
    }
    ```
  </Tab>

  <Tab value="Vanilla JS">
    ```html
    <!DOCTYPE html>
    <html>
    <head>
      <title>OnlyFans API Auth</title>
    </head>
    <body>
      <div class="auth-container">
        <button id="auth-button" class="auth-button">
          Connect OnlyFans Account
        </button>
        
        <div id="success-message" style="display: none;">
          <h3>Authentication Successful!</h3>
          <p id="account-id"></p>
          <p id="username"></p>
        </div>
        
        <div id="error-message" style="display: none;">
          <h3>Authentication Failed</h3>
          <p id="error-text"></p>
        </div>
      </div>

      <script type="module">
        import { startOnlyFansAuthentication } from '@onlyfansapi/auth';

        const authButton = document.getElementById('auth-button');
        const successMessage = document.getElementById('success-message');
        const errorMessage = document.getElementById('error-message');

        authButton.addEventListener('click', () => {
          authButton.disabled = true;
          authButton.textContent = 'Authenticating...';
          errorMessage.style.display = 'none';
          
          startOnlyFansAuthentication('ofapi_cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', {
            onSuccess: (data) => {
              console.log('Authentication successful:', data);
              document.getElementById('account-id').textContent = 
                'Account ID: ' + data.accountId;
              document.getElementById('username').textContent = 
                'Username: ' + data.username;
              successMessage.style.display = 'block';
              authButton.disabled = false;
              authButton.textContent = 'Connect OnlyFans Account';
            },
            onError: (error) => {
              console.error('Authentication failed:', error);
              document.getElementById('error-text').textContent = error.message;
              errorMessage.style.display = 'block';
              authButton.disabled = false;
              authButton.textContent = 'Connect OnlyFans Account';
            },
          });
        });
      </script>
    </body>
    </html>
    ```
  </Tab>
</Tabs>

## Response Data

The library provides TypeScript types for better type safety. Import them if needed:

```typescript
import type { AuthSuccessData, AuthError } from '@onlyfansapi/auth';
```

### Success Response

When authentication is successful, the `onSuccess` callback receives an `AuthSuccessData` object:

```typescript
interface AuthSuccessData {
  accountId: string;    // The authenticated OnlyFans account ID
  username: string;     // The authenticated OnlyFans username
  response: object;     // Full response object from the API containing additional metadata
}
```

**Example usage:**

```typescript
onSuccess: (data) => {
  // Store the account ID for future API requests
  localStorage.setItem('ofAccountId', data.accountId);
  
  // Redirect to dashboard or update UI
  console.log(`Authenticated as ${data.username}`);
}
```

### Error Response

When authentication fails, the `onError` callback receives an `AuthError` object:

```typescript
interface AuthError {
  message: string;       // Human-readable error message
  code?: string;        // Error code (if available) for programmatic handling
  details?: object;     // Additional error details (if available)
}
```

**Common error scenarios:**

* User cancels the authentication flow
* Network connectivity issues
* Invalid or expired client session token
* OnlyFans account access issues

**Example error handling:**

```typescript
onError: (error) => {
  if (error.code === 'AUTH_CANCELLED') {
    // User closed the authentication modal
    console.log('Authentication cancelled by user');
  } else {
    // Handle other errors
    console.error('Authentication failed:', error.message);
    // Display error to user
  }
}
```

## Security

The authentication library implements multiple security measures to protect user data:

* **Origin validation**: All communication with the authentication iframe is validated by origin
* **Domain whitelisting**: Only messages from the configured OnlyFansAPI.com domain are accepted
* **Secure token transmission**: Client session tokens are passed securely via URL parameters
* **HTTPS required**: The library requires HTTPS connections in production environments

## Best Practices

### Storing Client Session Tokens

Store your client session token securely:

```typescript
// ✅ Good: Use environment variables (if using a build tool)
const CLIENT_SECRET = process.env.NEXT_PUBLIC_OFAPI_CLIENT_SECRET;

// ✅ Good: Fetch from your backend API (most secure)
const clientSecret = await fetch('/api/client-secret').then(r => r.json());

// ❌ Bad: Hardcode in your source code
const CLIENT_SECRET = 'ofapi_cs_...';
```

### Error Handling

Always handle both success and error cases:

```typescript
startOnlyFansAuthentication("clientSecret", {
  onSuccess: (data) => {
    // Update your application state
    // Persist authentication data if needed
    // Redirect or update UI
  },
  onError: (error) => {
    // Log errors for debugging
    // Show user-friendly error messages
    // Provide fallback options
  },
});
```

### User Experience

* Show a loading state while authentication is in progress
* Disable the authentication button during the flow to prevent duplicate requests
* Provide clear feedback on success or failure
* Consider adding a "try again" option if authentication fails

## Troubleshooting

### Common Issues

**Authentication modal doesn't open:**

* Ensure your client session token is valid and properly formatted
* Check browser console for any error messages
* Verify that pop-ups aren't blocked by your browser

**"Invalid client secret" error:**

* Verify your client session token is correct (starts with `ofapi_cs_`)
* Check that the token hasn't expired
* Ensure you're using a token created via the [Create Client Session API](/api-reference/client-sessions/create-client-session)

**Network errors:**

* Check your internet connection
* Verify OnlyFansAPI.com is accessible from your network
* Some corporate firewalls may block the authentication iframe

## Next Steps

* Review the [Installation Guide](/auth/installation) if you haven't already
* Check out the [NPM package](https://www.npmjs.com/package/@onlyfansapi/auth) for the latest version and updates
* Visit [onlyfansapi.com/auth](https://onlyfansapi.com/auth) for more information
* Explore the [API Reference](/api-reference) to see what you can do with authenticated accounts

# Data Exports (/data-exports)

import { Step, Steps } from 'fumadocs-ui/components/steps';
import {
    ArrowLeftRightIcon,
    BanknoteArrowDownIcon, BanknoteXIcon,
    HeartIcon,
    ImageIcon,
    MessagesSquareIcon,
    TagIcon, TagsIcon,
    UserSearchIcon, UsersIcon, UserStarIcon
} from "lucide-react";

## Available data export types

<Cards className="grid grid-cols-3 gap-4 @container">
  <Card icon={<ArrowLeftRightIcon />} title="Transactions" />

  <Card icon={<MessagesSquareIcon />} title="Chat Messages" />

  <Card icon={<ImageIcon />} title="Media" />

  <Card icon={<TagsIcon />} title="Trial Links" />

  <Card icon={<UserSearchIcon />} title="Tracking Links" />

  <Card icon={<BanknoteArrowDownIcon />} title="Payouts" />

  <Card icon={<BanknoteXIcon />} title="Chargebacks" />

  <Card icon={<UsersIcon />} title="Public Profiles" />

  <Card icon={<UserStarIcon />} title="Followings" />

  <Card icon={<HeartIcon />} title="Fans" />
</Cards>

## Getting started

You can create and manage data exports in two ways:

* **Dashboard**: Visit the [Data Exports page](https://app.onlyfansapi.com/tools/data-export) on our Console for a no-code interface
* **API**: Use our [Data Exports API endpoints](#using-the-api) to programmatically create and manage exports

### Starting an export via Dashboard

To get started, click on the "Create Export" button, which will take you to the export creation page. You're then prompted customize your export:

<Steps>
  <Step>
    #### Data type

    As the first step, select the type of data you want to export. Please refer to [the list above](#available-data-export-types) for available export types.
  </Step>

  <Step>
    #### Export fields

    Select the fields you want to include in your export. For a full list of available fields, please refer to [the available export fields list](#available-export-fields).
  </Step>

  <Step>
    #### Accounts

    Choose which accounts you want to include in your export. You can select all connected accounts, or select specific accounts.
  </Step>

  <Step>
    #### Date range

    Select the data range that you wish to be included in your export.
  </Step>

  <Step>
    #### View the export cost

    For some Data Export types, it is not possible to calculate the cost upfront. If this is the case, it will be calculated once the export is completed. For other Data Export types, you will see the cost of the export here.
  </Step>

  <Step>
    #### Select the export file type

    Click on "Export Data", and choose either CSV or Excel (XSLX). This will start the export!
  </Step>

  <Callout title="That's it!" type="success">
    Your data export will now be processed by our servers in the background, and you will be able to download it once completed.
  </Callout>
</Steps>

## Using the API

Data exports can be created and managed either through our [Dashboard](https://app.onlyfansapi.com/tools/data-export) or programmatically using our API endpoints. The API provides full control over the export lifecycle, allowing you to automate data exports and integrate them into your workflows.

### Export workflow

The data export process follows a two-step workflow:

<Steps>
  <Step>
    #### Create Data Export

    Use the [Create Data Export](/api-reference/data-exports/create-data-export) endpoint to create a new export request. This endpoint will calculate the required credits based on your selected parameters (data type, fields, accounts, and date range) and prepare the export for processing.
  </Step>

  <Step>
    #### Start Data Export

    Once the export has been created and credit calculation is complete, use the [Start Data Export](/api-reference/data-exports/start-data-export) endpoint to begin processing. This will charge the calculated credits and start the actual export process.
  </Step>
</Steps>

### Monitoring exports

You can monitor the status and progress of your exports using the following endpoints:

* **[List Data Exports](/api-reference/data-exports/list-data-exports)** - Get a paginated list of all data exports for your team
* **[Get Data Export Status](/api-reference/data-exports/get-data-export-status)** - Check the current status, progress, and download URL for a specific export

Once an export is completed, you can download the file using the download URL provided in the export status response.

## Big data exports

Depending on the chosen date range and account size, your export might take several hours to complete if you're exporting a large amount of data. You can safely close the browser window, and return to the Data Exports page later to check the status of your export.

## Understanding export progress & row counts

When you create an export, we first scan OnlyFans to find every record that matches your selection, then write those records to the export file. The status endpoints — [Get Data Export Status](/api-reference/data-exports/get-data-export-status) and [List Data Exports](/api-reference/data-exports/list-data-exports) — and the dashboard surface a few fields that describe this progress:

| Field              | Dashboard label | What it means                                                                                                                                                                                                                                      |
| ------------------ | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `total_rows`       | Total Rows      | The number of matching records **found** for your export during scanning. Your credit cost is based on this number. For most export types every found row is written to the file, so `total_rows` equals the number of rows in the delivered file. |
| `rows_processed`   | —               | The number of rows actually **written to the export file** — i.e. the delivered count.                                                                                                                                                             |
| `failed_downloads` | —               | **Media exports only.** The number of media files that could not be downloaded (`failed_downloads = total_rows − rows_processed`). It is `0` for every other export type.                                                                          |

<Callout type="info" title="Why a media export can show more “rows” than files delivered">
  For media exports, each "row" is an individual file that has to be downloaded from OnlyFans and added to the ZIP. Unlike CSV or Excel exports — where every found row is always written to the file — a media file download can occasionally fail at the moment it runs (for example, a temporary access error).

  We automatically retry failed downloads, but a few may still not succeed within a single export run. This means a **completed** media export can legitimately contain fewer files than its **Total Rows**. The dashboard reflects this by showing, for example, **"48 of 50 media downloaded"** and, when any files failed, a **"Completed with N failed"** status instead of a plain success — so the numbers always reconcile:

  `total_rows` (found) = `rows_processed` (delivered) + `failed_downloads`

  If some files failed, simply re-run the export to attempt the remaining files again. These failures are usually transient and succeed on a later run.
</Callout>

<Callout type="info" title="Other export types always match">
  This rows-vs-delivered distinction only applies to **media** exports. For transactions, chat messages, payouts, and every other export type, each found row is always written to the file — so `total_rows` and `rows_processed` are always equal.
</Callout>

<Callout type="warn" title="DRM-protected videos can't be exported">
  Media Vault exports of **videos** will fail to download when **DRM is enabled** for them in OnlyFans. DRM-protected video files are encrypted and cannot be retrieved, so they will be counted as `failed_downloads` rather than written to the export file. Photos and other non-DRM media are unaffected.
</Callout>

## Available export fields

| Transactions     | Chat Messages                | Trial Links            | Tracking Links         | Payouts             | Chargebacks         | Public Profiles     | Media                                               | Fans               | Followings                    |
| ---------------- | ---------------------------- | ---------------------- | ---------------------- | ------------------- | ------------------- | ------------------- | --------------------------------------------------- | ------------------ | ----------------------------- |
| Account ID       | Account ID                   | Account ID             | Account ID             | Account ID          | Account ID          | OnlyFans ID         | ZIP of every media vault file (photo, video, audio) | ID                 | OnlyFans ID                   |
| Account Name     | Account Name                 | Account Name           | Account Name           | Account Name        | Account Name        | Username            |                                                     | OnlyFans ID        | Username                      |
| Account Username | Account Username             | Account Username       | Account Username       | Account Username    | Account Username    | Name                |                                                     | Username           | Name                          |
| Transaction ID   | Fan ID                       | OnlyFans ID            | OnlyFans ID            | OnlyFans ID         | OnlyFans ID         | About               |                                                     | Name               | Avatar                        |
| Type             | Fan Username                 | Name                   | Campaign Code          | Amount              | Payment Type        | Location            |                                                     | Display Name       | Is Performer                  |
| Fan ID           | Fan Name                     | URL                    | Campaign Name          | Currency            | Fan ID              | Website             |                                                     | Avatar             | Is Verified                   |
| Fan Username     | Chat ID                      | Claim Counts           | OnlyFans URL           | State               | Fan Username        | Subscribe Price     |                                                     | Location           | Is Real Performer             |
| Fan Name         | Message ID                   | Clicks Counts          | Count Subscribers      | Reject Reason       | Fan Name            | Min Subscribe Price |                                                     | Is Performer       | Subscribe Price               |
| Amount           | Message Text                 | Subscribe Counts       | Count Transitions      | OnlyFans Created At | Amount              | Posts Count         |                                                     | Is Verified        | Subscription Price            |
| VAT Amount       | Price                        | Subscribe Days         | Revenue                |                     | VAT Amount          | Photos Count        |                                                     | Can Add Subscriber | Subscription Autoprolong      |
| Tax Amount       | Tip Amount                   | Is Finished            | Revenue Per Subscriber |                     | Tax Amount          | Videos Count        |                                                     | Can Chat           | Subscription Is Muted         |
| Net Amount       | Is Free                      | Revenue                | Revenue Per Click      |                     | Media Tax Amount    | Audios Count        |                                                     | Subscribe Price    | Show Posts In Feed            |
| Fee Amount       | Is Tip                       | Revenue Per Subscriber | OnlyFans Created At    |                     | Net Amount          | Favorites Count     |                                                     | Total Summ         | Has Active Paid Subscriptions |
| Currency         | Sent by (`creator` or `fan`) | OnlyFans Created At    | OnlyFans End Date      |                     | Fee Amount          | Favorited Count     |                                                     | Messages Summ      | Subscription Status           |
| Description      | Is Opened                    | OnlyFans Expired At    |                        |                     | Currency            | Subscribers Count   |                                                     | Subscribes Summ    | Subscribe At                  |
| Status           | Media Count                  | Tags (comma separated) | Tags (comma separated) |                     | Description         | Is Verified         |                                                     | Posts Summ         | Expired At                    |
| Created At       | OnlyFans Created At          |                        |                        |                     | Status              | Is Performer        |                                                     | Tips Summ          | Renewed At                    |
|                  |                              |                        |                        |                     | Payment Created At  | Is Real Performer   |                                                     | Streams Summ       | Last Seen At                  |
|                  |                              |                        |                        |                     | OnlyFans Created At | Avatar URL          |                                                     | Rebill On          | Regular Price                 |
|                  |                              |                        |                        |                     |                     | Header URL          |                                                     | Subscribe At       | Discount Percent              |
|                  |                              |                        |                        |                     |                     | Instagram           |                                                     | Expired At         | Duration                      |
|                  |                              |                        |                        |                     |                     | Twitter             |                                                     | Renewed At         | Can Receive Chat Message      |
|                  |                              |                        |                        |                     |                     | TikTok              |                                                     |                    | Is Blocked                    |
|                  |                              |                        |                        |                     |                     | Facebook            |                                                     |                    | Can Unsubscribe               |
|                  |                              |                        |                        |                     |                     | Gender              |                                                     |                    | Tips Enabled                  |
|                  |                              |                        |                        |                     |                     | Gender Confidence   |                                                     |                    |                               |
|                  |                              |                        |                        |                     |                     | Join Date           |                                                     |                    |                               |
|                  |                              |                        |                        |                     |                     | Last Seen At        |                                                     |                    |                               |

## Pricing

The following pricing applies to our data exports:

| Export type     | Cost                    |
| --------------- | ----------------------- |
| Transactions    | 1 credit per 20 results |
| Chat Messages   | 1 credit per 20 results |
| Media           | 1 credit per 20 results |
| Trial Links     | 1 credit per 20 results |
| Tracking Links  | 1 credit per 20 results |
| Payouts         | 1 credit per 20 results |
| Chargebacks     | 1 credit per 20 results |
| Public Profiles | 3 credits per profile   |
| Fans            | 1 credit per 20 results |
| Followings      | 1 credit per 20 results |

# Use Cases (/data-exports/use-cases)

import { Callout } from 'fumadocs-ui/components/callout';
import {
    DatabaseIcon,
    UsersIcon,
    BrainCircuitIcon,
    BarChart3Icon,
    ArchiveIcon
} from "lucide-react";

Data exports unlock the full potential of your OnlyFans data. Whether you're building automations, training AI models, or migrating to new systems, our comprehensive export tools give you complete control over your data.

<Cards className="grid grid-cols-3 gap-4 @container">
  <Card icon={<BrainCircuitIcon />} title="AI & LLM Training" href="#download-media-and-chats-for-llm-and-lora-training" />

  <Card icon={<BarChart3Icon />} title="Financial Analytics" href="#export-financial-data-for-analytics-and-automation" />

  <Card icon={<ArchiveIcon />} title="Backup & Migration" href="#complete-data-backup-and-migration" />
</Cards>

***

## Download Media and Chats for LLM and LoRA Training

<Callout title="Perfect for" type="info">
  AI developers, chatbot builders, and content personalization tools
</Callout>

Training AI models to mimic a creator's voice, style, or persona? Our **Media** and **Chat Messages** exports provide the raw data you need for LLM fine-tuning and LoRA training.

### Media exports for visual AI

Export your entire **Media Vault** as a ZIP file containing:

* All photos (full resolution)
* All videos (original quality)
* All audio files

This is invaluable for training:

* **LoRA models** for Stable Diffusion and similar image generators
* **Content classifiers** and moderation systems
* **Style transfer** and editing tools

### Chat exports for language models

The **Chat Messages** export includes:

* Complete message history
* Message text and timestamps
* Fan context (ID, username, name)
* Tip and pricing data
* Media attachment counts

Use this data to:

* **Fine-tune LLMs** on a creator's communication style
* **Build AI chatbots** that authentically represent creator personalities
* **Analyze conversation patterns** for engagement optimization
* **Train response suggestion systems**

### Technical integration

```python title="Example: Processing chat exports for training"
import pandas as pd

# Load your chat export
chats = pd.read_csv('chat_messages_export.csv')

# Filter for creator's own messages
creator_messages = chats[chats['Is From Account'] == True]

# Prepare training pairs
training_data = []
for idx, row in creator_messages.iterrows():
    training_data.append({
        "role": "assistant",
        "content": row['Message Text']
    })

# Export for fine-tuning
# ... your ML pipeline here
```

***

## Export Financial Data for Analytics and Automation

<Callout title="Perfect for" type="info">
  Accountants, agencies managing multiple creators, and analytics platforms
</Callout>

Need to sync your OnlyFans financial data with external tools? Export **Transactions**, **Payouts**, and **Chargebacks** to power your analytics dashboards and automation workflows.

### Available financial exports

| Export Type      | Key Fields                                                      |
| ---------------- | --------------------------------------------------------------- |
| **Transactions** | Amount, VAT, tax, net, fee, currency, type, status, fan details |
| **Payouts**      | Amount, currency, state, reject reason, timestamps              |
| **Chargebacks**  | Amount, payment type, status, fan info, media tax breakdown     |

### Power your automation stack

Integrate data exports with tools like **n8n**, **Zapier**, or **Make** to build powerful financial workflows:

#### Example: n8n revenue sync workflow

1. **Schedule trigger** — Run weekly or monthly
2. **API call** — Create and start a Transactions export
3. **Wait for completion** — Poll export status
4. **Download CSV** — Fetch the completed export
5. **Parse data** — Transform for your target system
6. **Update database** — Sync to Airtable, Google Sheets, or your data warehouse
7. **Trigger alerts** — Notify on anomalies (chargebacks, revenue drops)

<Callout title="Backfill historical data" type="success">
  Starting fresh with a new analytics tool? Export your **entire transaction history** to backfill your database with years of financial data in minutes.
</Callout>

### Real-world applications

* **Revenue dashboards**: Sync to Metabase, Tableau, or custom BI tools
* **Tax preparation**: Export all transactions for your accountant
* **Chargeback monitoring**: Track and analyze disputed payments
* **Multi-account reconciliation**: Consolidate finances across all managed creators
* **Payout forecasting**: Analyze historical patterns to predict future earnings

***

## Complete Data Backup and Migration

<Callout title="Perfect for" type="info">
  Creators switching platforms, agencies managing transitions, and disaster recovery
</Callout>

Your OnlyFans data is valuable. Whether you're preparing for a platform migration, setting up disaster recovery, or just want peace of mind, our comprehensive exports have you covered.

### Export everything

| Data Type           | What's Included                                    |
| ------------------- | -------------------------------------------------- |
| **Media**           | Every photo, video, and audio file from your vault |
| **Chat Messages**   | Complete conversation history with all fans        |
| **Transactions**    | Full financial record of all earnings              |
| **Trial Links**     | All free trial campaigns and performance data      |
| **Tracking Links**  | Marketing campaign data and attribution            |
| **Payouts**         | Complete payout history                            |
| **Chargebacks**     | Dispute and chargeback records                     |
| **Public Profiles** | Profile snapshots for record-keeping               |

### Backup strategy

Set up a robust backup workflow:

1. **Monthly full exports** — Download all data types for comprehensive snapshots
2. **Weekly incremental exports** — Export recent data using date range filters
3. **Store securely** — Save to cloud storage (S3, Google Cloud, Azure) or local NAS
4. **Version your backups** — Maintain historical snapshots for point-in-time recovery

### Migration use cases

* **Platform switch**: Export everything before moving to a new content platform
* **Agency transition**: Hand off complete data when onboarding or offboarding creators
* **Legal compliance**: Maintain records for regulatory requirements
* **Content repurposing**: Access your full media library for use on other platforms

<Callout title="Large exports?" type="info">
  Exporting years of data? Our system handles big exports seamlessly. Start the export, close your browser, and come back later to download your complete archive.
</Callout>

***

## Get Started

Ready to unlock the full potential of your OnlyFans data?

<Cards>
  <Card title="Create Your First Export" href="https://app.onlyfansapi.com/tools/data-export" description="Use our no-code dashboard to export data in minutes" />

  <Card title="API Reference" href="/api-reference/data-exports/create-data-export" description="Automate exports programmatically with our API" />

  <Card title="n8n Integration" href="/integrations/n8n" description="Build automated workflows with n8n" />
</Cards>

# Add an integration (/fansbot/add-an-integration)

import { Step, Steps } from "fumadocs-ui/components/steps";

Integrations let FansBot work with the other tools you use. Connect apps like Google Sheets, Gmail, Notion, Google Calendar, Airtable, HubSpot, or Stripe, and FansBot can read from and act on them — both in live chats and in [scheduled tasks](/fansbot/scheduled-tasks).

## Connect an app

In your [OnlyFansAPI dashboard](https://app.onlyfansapi.com), open **FansBot → Integrations** in the sidebar.

<img alt="FansBot integrations catalog" src={__img0} placeholder="blur" />

<Steps>
  <Step>
    ### Find the app \[!toc]

    Search the catalog — there are 3,000+ apps to choose from — and pick the one you want. Switch to **Popular integrations** to see the most-used ones, or flip on **Show connected only** to see just the apps you've already connected.
  </Step>

  <Step>
    ### Choose team or personal, then connect \[!toc]

    Pick **Connect a team account** (everyone on your team can use it) or **Connect a personal account** (just for you), then authorize FansBot to access it. You can connect one of each per app.
  </Step>

  <Step>
    ### Confirm it's connected \[!toc]

    The app now shows it's connected, tagged **Team** or **Personal**.
  </Step>
</Steps>

<Callout title="Team vs. personal accounts">
  A **team** integration is shared — anyone on your team can use it through FansBot. A **personal** integration is just for you. When someone chats with a FansBot channel, it can use your team's shared integrations plus the personal integrations of whoever set that channel up.
</Callout>

<Callout title="Can't find an app?">
  Click **Request integration** at the top of the page to tell us which app you'd like, and we'll look into adding it.
</Callout>

## Use it in chat

Once an app is connected, just ask FansBot to use it:

* "Add my top 10 fans this month to a Google Sheet."
* "What's on my calendar today?"
* "Draft an email to my VA with this week's numbers."

FansBot figures out which connected app to use and — for anything that writes or sends — confirms with you before going ahead.

# Channels (/fansbot/channels)

import { Step, Steps } from "fumadocs-ui/components/steps";
import { Tabs, Tab } from "fumadocs-ui/components/tabs";

A **channel** is a chat platform where your team talks to FansBot — a private bot in Telegram, Slack, or Discord. You can connect more than one; the same FansBot works across all of them.

## Open the Channels tab

In your [OnlyFansAPI dashboard](https://app.onlyfansapi.com), open **FansBot** in the sidebar. You land on the **Channels** tab, which lists every channel you've connected with its platform, access, and status.

<img alt="FansBot Channels tab" src={__img0} placeholder="blur" />

Click **Add channel** and pick a platform.

<img alt="Add a channel — platform picker" src={__img1} placeholder="blur" />

The steps differ slightly per platform:

<Tabs items={['Telegram', 'Slack', 'Discord']}>
  <Tab value="Telegram">
    <Steps>
      <Step>
        ### Create a bot with @BotFather \[!toc]

        In Telegram, open [@BotFather](https://t.me/BotFather), send `/newbot`, and follow the prompts. Copy the **bot token** it gives you — it looks like `1234567890:ABC-DEF...`.
      </Step>

      <Step>
        ### Add the channel \[!toc]

        In the platform picker, choose **Telegram**. Give the channel a **name**, paste your **Telegram Bot Token**, and save.
      </Step>

      <Step>
        ### Find your User ID \[!toc]

        A new Telegram bot won't talk to anyone yet. Open your bot, send it any message, and it replies that you're not allowed — along with **your Telegram User ID**. Copy that ID.
      </Step>

      <Step>
        ### Allow yourself to chat \[!toc]

        On the **Channels** tab, open the channel's **Configure** menu and paste your User ID into **Permitted Users IDs** (separate multiple IDs with commas). Save, then message the bot again and it'll respond.
      </Step>
    </Steps>

    <Callout title="Who can use the bot?">
      A Telegram channel is **locked by default** — only the User IDs you add to **Permitted Users IDs** can chat. Anyone else is shown their own User ID, so adding a teammate is just a copy-paste. Send `/start` any time to reset the conversation.
    </Callout>
  </Tab>

  <Tab value="Slack">
    <Steps>
      <Step>
        ### Choose Slack \[!toc]

        In the platform picker, choose **Slack**, then click **Add to Slack**.
      </Step>

      <Step>
        ### Authorize your workspace \[!toc]

        You're redirected to Slack to authorize the OnlyFans API app and pick the workspace to install it into. Confirm, and you're returned to the dashboard with the workspace listed as a channel.
      </Step>

      <Step>
        ### Start chatting \[!toc]

        Send FansBot a direct message, or invite it to a channel and mention it.
      </Step>
    </Steps>
  </Tab>

  <Tab value="Discord">
    <Steps>
      <Step>
        ### Choose Discord \[!toc]

        In the platform picker, choose **Discord**, then click **Add to Discord**.
      </Step>

      <Step>
        ### Pick a server \[!toc]

        You're redirected to Discord to add the OnlyFans API bot to a server you manage. Authorize it, and you're returned to the dashboard with the server listed as a channel.
      </Step>

      <Step>
        ### Set who can use it \[!toc]

        By default **everyone** in the server can chat with the bot. To restrict it, open the channel's **Configure** menu and turn off **Allow everyone**, then pick the specific **permitted members** (see below).
      </Step>

      <Step>
        ### Start chatting \[!toc]

        In a server channel, **@mention** the bot (for example, `@FansBot`) to talk to it — Discord doesn't support DMing the bot. Once it replies, you can keep chatting in that thread without mentioning it again.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Callout type="success" title="Connected!">
  Your channel shows as **Live** on the Channels tab. Next, learn [what to ask FansBot](/fansbot/talking-to-fansbot).
</Callout>

## Manage a channel

On the **Channels** tab, open the menu at the end of any row. **Telegram** and **Discord** channels have a **Configure** option; **Slack** isn't configurable. Any channel can be removed with **Delete**. The **Access** column shows who can chat — **Public** when everyone is allowed, or a count like **3 permitted** when you've restricted it.

### Permitted users

* **Telegram** — Configure lists **Permitted Users IDs**, a comma-separated list of the Telegram User IDs allowed to chat. Anyone not on the list is shown their own ID so an admin can add them.
* **Discord** — Configure has an **Allow everyone** switch. Turn it off to reveal a **Permitted members** picker: search your server's members and select exactly who can chat. Members who join the server later won't have access until you add them.

{/* TODO screenshot: Discord channel → Configure → "Allow everyone" switch + permitted-members picker (not yet exposed in the live build) */}

# FansBot (/fansbot)

import { Card, Cards } from "fumadocs-ui/components/card";
import {
  PlugIcon,
  MessageSquareTextIcon,
  PuzzleIcon,
  GraduationCapIcon,
  CalendarClockIcon,
  WorkflowIcon,
  GaugeIcon,
} from "lucide-react";

FansBot is an AI assistant that lives in your team's chat app. Connect Telegram, Slack, or Discord, then just message it to check earnings, find your top fans, review subscriber growth, track link performance, run any OnlyFans action, search the web, and automate recurring reports — no dashboard digging, no code.

<Callout>
  FansBot is powered by your OnlyFansAPI account and works across every creator on your roster. Each message it answers uses [credits](/introduction/essentials/credits).
</Callout>

## How it works

FansBot is managed from the **FansBot** section of your [OnlyFansAPI dashboard](https://app.onlyfansapi.com), organized into a few tabs:

1. **Channels** — add a Telegram bot, or install FansBot into your Slack workspace or Discord server. This is where your team talks to it.
2. **Integrations** — connect the other apps you use (Google Sheets, Gmail, Notion, and more) so FansBot can read and act on them.
3. **Skills** — install curated know-how that teaches FansBot how to handle specific jobs, like earnings recaps or ad reviews.
4. **Scheduled Tasks & Workflows** — automate recurring reports and reminders, either from scratch or from a ready-made workflow.

Once a channel is connected, you just message FansBot in plain language. It reads live data from your connected OnlyFans accounts and replies right in the chat.

## Supported platforms

| Platform        | Status      | How you connect           |
| --------------- | ----------- | ------------------------- |
| Telegram        | Available   | Bot token from @BotFather |
| Slack           | Available   | 1-click install (OAuth)   |
| Discord         | Available   | 1-click install (OAuth)   |
| WhatsApp        | Coming soon | —                         |
| Microsoft Teams | Coming soon | —                         |

## Get started

<Cards>
  <Card icon={<PlugIcon className="text-fd-primary" />} href="/fansbot/channels" title="Channels">
    Add FansBot to Telegram, Slack, or Discord.
  </Card>

  <Card icon={<MessageSquareTextIcon className="text-fd-primary" />} href="/fansbot/talking-to-fansbot" title="Talking to FansBot">
    What to ask, and how the assistant responds.
  </Card>

  <Card icon={<PuzzleIcon className="text-fd-primary" />} href="/fansbot/add-an-integration" title="Add an integration">
    Connect your other apps so FansBot can act on them.
  </Card>

  <Card icon={<GraduationCapIcon className="text-fd-primary" />} href="/fansbot/skills" title="Skills">
    Install curated skills to teach FansBot specific jobs.
  </Card>

  <Card icon={<CalendarClockIcon className="text-fd-primary" />} href="/fansbot/scheduled-tasks" title="Scheduled tasks">
    Automate recurring reports and reminders.
  </Card>

  <Card icon={<WorkflowIcon className="text-fd-primary" />} href="/fansbot/workflows" title="Workflows">
    Start from ready-made, pre-built scheduled tasks.
  </Card>

  <Card icon={<GaugeIcon className="text-fd-primary" />} href="/fansbot/usage" title="Checking usage">
    Track credits, models, and activity.
  </Card>
</Cards>

<Callout title="Don't see FansBot in your dashboard?">
  FansBot is managed from your [OnlyFansAPI dashboard](https://app.onlyfansapi.com). If the FansBot section isn't visible on your team, reach out at [hello@onlyfansapi.com](mailto:hello@onlyfansapi.com).
</Callout>

# Scheduled tasks (/fansbot/scheduled-tasks)

A scheduled task is a recurring job FansBot runs on a schedule and delivers to a chat you choose — a daily earnings summary, a weekly recap, a morning reminder, or anything else you can ask FansBot to do.

<img alt="Scheduled tasks list" src={__img0} placeholder="blur" />

<Callout>
  Want a head start? Browse [Workflows](/fansbot/workflows) for ready-made scheduled tasks you can set up in one click.
</Callout>

## Create a task

There are two ways to set one up.

### Ask in chat

Just tell FansBot what you want:

> "Send me a daily earnings summary for the whole agency every morning at 8am."

FansBot confirms the details — including your timezone, which it asks for if you haven't said — creates the task, and offers to run it once right away as a preview.

### Use the dashboard

In your [OnlyFansAPI dashboard](https://app.onlyfansapi.com), open **FansBot → Scheduled Tasks** and click **New scheduled task**. Fill in:

* **Name** — a label for the task.
* **Connection** — which connected channel delivers it (chosen when you create the task).
* **Send to** — the destination on that channel (the chat or user ID).
* **Model** — the AI model that runs the task: **Claude** (Opus, Sonnet, Haiku), **GPT** (GPT, GPT Mini, GPT-5.4 Nano), or **Gemini** (Pro, 3.1 Flash Lite). Defaults to **Claude Sonnet**.
* **Prompt** — what you want FansBot to do on each run.
* **Frequency** — Daily, Weekly, Monthly, every N minutes/hours, or a custom cron expression, plus the **time / days** and **timezone**.

<img alt="New scheduled task form with the model picker open" src={__img1} placeholder="blur" />

## Manage tasks

Each task is a card showing its schedule, status, last run, and next run. Switch between **All tasks** and **My tasks**. From a card you can:

* **Run now** — trigger it immediately.
* **Edit** — change the prompt, schedule, or destination.
* **Pause / Resume** — stop it running without deleting it.
* **Delete** — remove it for good.

<Callout>
  Scheduled task runs use [credits](/introduction/essentials/credits) too, billed to the model you pick. See them broken out on the [usage page](/fansbot/usage).
</Callout>

# Skills (/fansbot/skills)

Skills are curated playbooks that teach FansBot how to handle a specific job well — a weekly earnings recap, a top-spender breakdown, a Google Ads audit, and so on. Install the ones you want, and FansBot follows them automatically whenever a chat or [scheduled task](/fansbot/scheduled-tasks) calls for it. Installed skills apply across **all** your team's channels.

<img alt="FansBot Skills catalog" src={__img0} placeholder="blur" />

## Install a skill

In your [OnlyFansAPI dashboard](https://app.onlyfansapi.com), open **FansBot → Skills**. Search the catalog or filter by category (Analytics, Coaching, Engagement, Fans, Messaging, Portfolio, and more), then click **Install** on any skill. Each card shows the skill's name, category, a short description, and tags.

To stop using one, open its menu and choose **Remove** — FansBot stops using it for your team, and you can re-install it any time.

## Skill bundles

A **bundle** is a curated set of related skills you can install in one click — a fast way to teach FansBot a whole area at once. Bundles appear at the top of the Skills page, each showing how many skills it includes.

* **Install bundle** adds every skill in the set.
* Open a bundle to see **Skills in this bundle** and install or remove them individually.
* **Remove bundle** uninstalls every skill in it — including any you also installed on their own or through another bundle.

<Callout>
  Skills don't cost anything to install. They only shape how FansBot works — you're still billed [credits](/introduction/essentials/credits) for the messages and tasks that use them.
</Callout>

# Talking to FansBot (/fansbot/talking-to-fansbot)

Once a channel is connected, talking to FansBot is just messaging it. Depending on the platform you either DM it or mention it in a channel (see the platform notes below) — then it replies right there in the chat. The first time, it introduces itself as **FansBot**, your agency assistant.

<img alt="FansBot saying hello in Slack" src={__img0} placeholder="blur" />

## What you can ask

FansBot reads live data from every OnlyFans account connected to your team. A few examples:

* "How much did we earn this week?"
* "Who are my top fans this month?"
* "How many new subscribers today?"
* "How are my tracking links performing?"
* "Give me an overview of @creator's account."
* "Set up a daily earnings summary at 8am."
* "What apps do I have connected?"
* "Search the web for the going rate on PPV bundles right now."

It can also act on your [connected integrations](/fansbot/add-an-integration) — for example, pulling a list of your spreadsheets or your upcoming calendar events:

<img alt="FansBot listing spreadsheets in Telegram" src={__img1} placeholder="blur" />

<img alt="FansBot listing calendar events in Discord" src={__img2} placeholder="blur" />

## How it behaves

* **It asks before making changes.** Anything that creates, edits, or deletes — a scheduled task, a tracking link, and so on — is summarized first with a "Should I go ahead?" confirmation.
* **It never invents data.** If it can't find something, it tells you.
* **It works while you wait.** For multi-step questions, it posts a quick "on it…" and follows up with the answer.
* **It uses your installed skills.** When a request matches a skill your team has [installed](/fansbot/skills), FansBot follows that playbook automatically — you don't have to invoke it.
* **It can search the web.** When a question needs outside information, FansBot looks it up. Web searches are billed separately — see [usage](/fansbot/usage).
* **It can send you files.** FansBot can post files straight into the chat (a CSV export, a generated image, and so on). File size limits depend on the platform: roughly 10 MB on Discord, 50 MB on Telegram, and 100 MB on Slack.

## Platform notes

* **Telegram:** the bot only replies to users on the channel's **Permitted Users IDs** list — anyone else is shown their own User ID so an admin can add them (see [Channels](/fansbot/channels)). Send `/start` to reset the conversation and clear history.
* **Slack:** send FansBot a direct message, or invite it to a channel and mention it.
* **Discord:** **@mention** the bot (for example, `@FansBot`) in a server channel to start — Discord DMs aren't supported. After it replies, keep chatting in that thread without re-mentioning it. Who can use it is set per channel from the dashboard (**Allow everyone**, or a list of permitted members) — see [Channels](/fansbot/channels).

<Callout>
  Every answer uses [credits](/introduction/essentials/credits). Track what FansBot is spending on the [usage page](/fansbot/usage).
</Callout>

# Checking usage (/fansbot/usage)

FansBot usage is billed in [credits](/introduction/essentials/credits). To see what it's spending, open **Usage** in your [OnlyFansAPI dashboard](https://app.onlyfansapi.com) sidebar and switch to the **FansBot** tab.

<img alt="FansBot usage page" src={__img0} placeholder="blur" />

## Usage chart

The chart shows credits used by FansBot over time. Use the controls to dig in:

* **Dimension** — group the chart by **Request Type** (for example, chat vs. scheduled task), **Model**, or **Platform**.
* **Period** — Today, the past 7 or 30 days, the past 6 months, the past year, or all time.

## Activity table

Below the chart, **FansBot Activity** lists individual requests — model calls, tokens, and cost:

| Column   | What it shows                         |
| -------- | ------------------------------------- |
| Platform | Telegram, Slack, or Discord           |
| Model    | The AI model that handled the request |
| User     | Who triggered it                      |
| Type     | Chat, scheduled task, and so on       |
| Credit   | Credits the request cost              |
| Cost     | The equivalent cost                   |
| Date     | When it ran                           |

Filter by **Platform**, **Model**, or **date range** to narrow it down.

<Callout title="What about web search?">
  When FansBot searches the web, that's billed at a flat rate per search (rather than per token) and shows up in the activity breakdown alongside your chat and scheduled-task usage.
</Callout>

<Callout>
  Running low? Top up from [Billing](https://app.onlyfansapi.com/billing) in your dashboard.
</Callout>

# Workflows (/fansbot/workflows)

import { Step, Steps } from "fumadocs-ui/components/steps";

Workflows are pre-built [scheduled tasks](/fansbot/scheduled-tasks) — the fastest way to get value without writing a prompt from scratch. Pick one, choose where it should report, and it runs on a schedule. Each is built on a [skill](/fansbot/skills), so the output is tuned for the job.

<img alt="FansBot Workflows gallery" src={__img0} placeholder="blur" />

## Use a workflow

In your [OnlyFansAPI dashboard](https://app.onlyfansapi.com), open **FansBot → Workflows**. Browse by category (Analytics, Coaching, Engagement, Reports) or search. Each card shows what it does, its suggested schedule, whether it **includes a skill**, and any apps it **requires**.

<Steps>
  <Step>
    ### Click "Use workflow" \[!toc]

    This opens the task form, pre-filled with the workflow's name, prompt, and suggested schedule. You can tweak any of it.
  </Step>

  <Step>
    ### Choose where it reports \[!toc]

    Pick the **connection** (which channel delivers it) and the **destination** on that channel. You need at least one [channel](/fansbot/channels) connected — the **Use workflow** button is disabled until you do.
  </Step>

  <Step>
    ### Connect any required apps \[!toc]

    Some workflows need an [integration](/fansbot/add-an-integration) first — for example, *Weekly Earnings → Google Sheets* needs Google Sheets. The form shows what's missing and a **Connect** button for each, and won't let you create the task until they're connected.
  </Step>

  <Step>
    ### Create it \[!toc]

    Submit, and the workflow becomes a regular scheduled task. Manage it from the [Scheduled Tasks](/fansbot/scheduled-tasks) tab like any other.
  </Step>
</Steps>

<img alt="Using a workflow that requires Google Sheets" src={__img1} placeholder="blur" />

<Callout>
  A workflow is just a starting point — once created it's an ordinary scheduled task, so it uses [credits](/introduction/essentials/credits) on each run, billed to the model you pick.
</Callout>

# Integrations (/integrations)

import {
    SiMake,
    SiMakeHex,
    SiZapier,
    SiZapierHex,
    SiIfttt,
    SiIftttHex,
    SiN8n,
    SiN8nHex
} from "@icons-pack/react-simple-icons";

<span className="text-2xl font-semibold">
  Please choose an integration to get started:
</span>

<Cards>
  <Card icon={<SiN8n color={SiN8nHex} />} href="/integrations/n8n" title="n8n (recommended)">
    <span className="font-medium text-fd-primary">Best for building complex, multi-step no-code automations.</span> Perfect for users who want powerful automation capabilities with full control over their workflows.
  </Card>

  <Card icon={<SiMake color={SiMakeHex} />} href="/integrations/make" title="Make">
    <span className="font-medium text-fd-primary">Best for simple OnlyFans automations</span>, all without writing code. Ideal for users who want simple visual workflow design.
  </Card>

  <Card icon={<SiZapier color={SiZapierHex} className="bg-white rounded" />} href="/integrations/zapier" title="Zapier">
    <span className="font-medium text-fd-primary">Best for quickly setting up no-code automations based on triggers like new messages, PPV purchases, or new fan subscriptions.</span> Great for those who want ease-of-use and a large library of app connections.
  </Card>
</Cards>

<span className="text-xl font-semibold">
  Or watch our tutorial video:
</span>

<iframe className="aspect-video w-full" src="https://www.youtube.com/embed/6C8DzQSDorI" title="Automate Anything on OnlyFans with NO CODE! 🚀 | OnlyFansAPI Tutorial" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen />

# Introduction (/introduction)

import {
    BookIcon,
    BotIcon,
    BotMessageSquareIcon,
    ChartBarIcon,
    CloudDownloadIcon,
    CodeXmlIcon,
    KeyRoundIcon,
    LinkIcon,
    LockIcon,
    MailIcon,
    MessageCircleQuestionMarkIcon,
    PuzzleIcon,
    ShieldCheckIcon,
    SparklesIcon,
    WebhookIcon,
} from 'lucide-react';
import { SiMeta, SiMetaHex } from '@icons-pack/react-simple-icons';

## Why OnlyFansAPI.com?

OnlyFansAPI.com is a platform that allows you to interact with the OnlyFans API without the need to build
your proxy management system, reverse engineer the API, or deal with WebSockets.

Our engineers have spent years building **350+ simple REST API endpoints** that cover everything OnlyFans agencies, creators, and developers need:

* Connect any OnlyFans account in under 2 minutes
* Read and send messages, posts, mass-DMs, and PPVs
* Pull earnings, transactions, fans, and chargebacks
* Manage media vault, queue, stories, and promotions
* Receive real-time webhook events for new messages, subs, tips, and more
* Search a database of 3.5M+ public OnlyFans creator profiles

## Popular use cases

What teams build on OnlyFansAPI today:

<Cards>
  <Card icon={<SiMeta color={SiMetaHex} />} title="Track Meta Ads & media buying revenue" href="/introduction/guides/onlyfans-meta-pixel-smart-links">
    Server-side Smart Links attribute every click, sub, and dollar to the right creative. No pixels, no lost events.
  </Card>

  <Card icon={<LinkIcon className="text-rose-500" />} title="Attribute ad revenue with Smart Links" href="/api-reference/smart-links/list-smart-links">
    Server-side tracking for Meta, TikTok, and Snapchat media buyers — every click, sub, and dollar tied to the right creative. No pixels, no lost events.
  </Card>

  <Card icon={<BotIcon className="text-emerald-500" />} title="Build AI chatters and chatbot SaaS" href="/api-reference/chat-messages/send-message">
    Read live chats, send replies, manage queue, and apply tags — the same surface our partners build chatbot products on.
  </Card>

  <Card icon={<BotMessageSquareIcon className="text-cyan-500" />} title="Run your agency with FansBot AI" href="/fansbot">
    Our AI agency assistant in Telegram, Slack, and Discord — chat to manage creators, draft replies, run workflows, and get earnings digests.
  </Card>

  <Card icon={<ChartBarIcon className="text-teal-500" />} title="Build dashboards, CRMs, and BI" href="/api-reference/analytics-summary/get-earnings-overview">
    Pull statistics, transactions, and fan analytics into Postgres, BigQuery, or your in-house dashboard.
  </Card>

  <Card icon={<SparklesIcon className="text-purple-500" />} title="Run your agency from Claude, ChatGPT, or Manus" href="/onlyfans-ai">
    350+ tools across chats, fans, and earnings via the OnlyFans MCP — ask in plain English, get reports, drafts, and digests.
  </Card>

  <Card icon={<PuzzleIcon className="text-sky-500" />} title="Automate without code (n8n, Make, Zapier)" href="/integrations">
    Trigger workflows on new messages, PPV purchases, subs, tips, and more — no engineer required.
  </Card>

  <Card icon={<MailIcon className="text-amber-500" />} title="Send mass DMs & re-engagement campaigns" href="/api-reference/mass-messaging/send-mass-message">
    Schedule, target, and track mass-message performance across creators.
  </Card>
</Cards>

## Browse the docs

OnlyFansAPI has different areas:

<Cards>
  <Card icon={<BookIcon className="text-emerald-500" />} title="API Reference" href="/api-reference">
    Every endpoint, request/response shapes, and SDK snippets.
  </Card>

  <Card icon={<WebhookIcon className="text-amber-500" />} title="Webhooks" href="/webhooks">
    Get notified about new messages, subs, tips, chargebacks, and more.
  </Card>

  <Card icon={<LinkIcon className="text-rose-500" />} title="Smart Links" href="/api-reference/smart-links/list-smart-links">
    Server-side attribution links for Meta, TikTok, and Snapchat media buying.
  </Card>

  <Card icon={<SparklesIcon className="text-purple-500" />} title="OnlyFans x AI Tools" href="/onlyfans-ai">
    Run your agency from Claude, ChatGPT, or Manus via the OnlyFans MCP.
  </Card>

  <Card icon={<BotMessageSquareIcon className="text-cyan-500" />} title="FansBot" href="/fansbot">
    Your AI agency assistant in Telegram, Slack, and Discord.
  </Card>

  <Card icon={<PuzzleIcon className="text-sky-500" />} title="Integrations" href="/integrations">
    No-code automations with n8n, Make, and Zapier.
  </Card>

  <Card icon={<CloudDownloadIcon className="text-teal-500" />} title="Data Exports" href="/data-exports">
    Bulk export transactions, messages, and more.
  </Card>

  <Card icon={<ShieldCheckIcon className="text-indigo-500" />} title="Login with OnlyFans" href="/auth">
    OnlyFans API's official authentication library.
  </Card>

  <Card icon={<MessageCircleQuestionMarkIcon className="text-fd-muted-foreground" />} title="FAQ" href="/faq">
    Common questions about plans, limits, and account safety.
  </Card>
</Cards>

## Get started

Whether you're building a chatbot, OnlyFans Search Engine, OnlyFans CRM, or anything else, you can get started with OnlyFansAPI.com in minutes.

<Cards>
  <Card title="Make your first API Request" icon={<CodeXmlIcon />} href="/introduction/quickstart">
    Learn how to make your first API request and get started with OnlyFans API
  </Card>

  <Card title="Get your API Key" icon={<KeyRoundIcon />} href="https://app.onlyfansapi.com/api-keys">
    Create your first API Key and start making requests
  </Card>

  <Card title="Connect your OnlyFans accounts" icon={<LockIcon />} href="/introduction/guides/connect-onlyfans-account">
    Learn how to connect you OnlyFans accounts in under 2 minutes
  </Card>

  <Card title="Get Webhook Notifications" icon={<WebhookIcon />} href="/webhooks">
    Get webhook notifications for new messages, new subscribers, tips, ...
  </Card>
</Cards>

# Quickstart (2m) (/introduction/quickstart)

import {
    CodeIcon, CoinsIcon, GaugeIcon, ShieldHalfIcon, ShieldIcon, ShieldUserIcon,
} from "lucide-react";

## Getting Started with OnlyFans API

Follow these steps to start using the OnlyFans API for your project.

### 1. Create Your API Key

To get started with the OnlyFans API, you'll need an API key:

1. Sign up for an account at [OnlyFans API Console](https://app.onlyfansapi.com)
2. Navigate to the API Keys section
3. Create a new API key for your project
4. Save your API key securely - you'll need it for all API requests

### 2. Connect Your OnlyFans Account

You'll need to connect your OnlyFans account to use the API. We offer two methods:

#### Automated Login Flow (Recommended)

1. Go to [OnlyFans API Console -> Accounts](https://app.onlyfansapi.com/accounts)
2. Click "+ Connect Account"
3. Follow the setup process (supports 2FA and captcha)

#### Manual cURL Method

An alternative method using cURL request is available. See our [detailed guide](/introduction/guides/connect-onlyfans-account) for instructions.

### 3. Essential Concepts

Before you start making API calls, familiarize yourself with these important concepts:

<Cards>
  <Card title="Response Structure" icon={<CodeIcon/>} href="/introduction/essentials/response-structure">
    Understand how our API responses are structured.
  </Card>

  <Card title="Rate Limits" icon={<GaugeIcon/>} href="/introduction/essentials/rate-limits">
    Understand API rate limits and how to handle them properly.
  </Card>

  <Card title="Credits System" icon={<CoinsIcon/>} href="/introduction/essentials/credits">
    Learn about our credit-based billing and how to manage your usage.
  </Card>

  <Card title="Proxy Usage" icon={<ShieldUserIcon/>} href="/introduction/essentials/proxies">
    Learn about proxy options for secure API access.
  </Card>
</Cards>

### 4. Next Steps

Once you're set up, you can:

* Explore our API endpoints in the [API Reference](/api-reference)
* Test API calls directly from our documentation
* Start building your application with our comprehensive guides

# OnlyFans x AI Tools (/onlyfans-ai)

import {
    SiClaude,
    SiClaudeHex,
} from "@icons-pack/react-simple-icons";
import { SiOpenai } from "react-icons/si";
import { PlugIcon } from "lucide-react";

OnlyFans MCP lets you connect Claude, ChatGPT, Manus, Cursor, and any other custom AI tool to your OnlyFans agency. 350+ tools across chats, fans, earnings, and every creator on your roster — no coding required.

<Callout>
  New here? Start with the [OnlyFans MCP overview](/onlyfans-ai/mcp) to learn what MCP is and how the install flow works. Then pick the guide for the AI tool your team uses.
</Callout>

## Pick your AI tool

<Cards>
  <Card icon={<PlugIcon className="text-fd-primary" />} href="/onlyfans-ai/mcp" title="OnlyFans MCP">
    <span className="font-medium text-fd-primary">Start here.</span> What MCP is, the server URL, and which AI clients are supported.
  </Card>

  <Card icon={<SiClaude color={SiClaudeHex} />} href="/onlyfans-ai/mcp/claude" title="Claude">
    <span className="font-medium text-fd-primary">Best for long-form ops, research, and agentic workflows.</span> Works with Claude Desktop, Claude.ai, Claude Code, and the Anthropic API.
  </Card>

  <Card icon={<SiOpenai />} href="/onlyfans-ai/mcp/chatgpt" title="ChatGPT">
    <span className="font-medium text-fd-primary">Best for team-wide Custom GPTs, Agent Mode, and Deep Research.</span> Requires a paid ChatGPT plan (Pro, Business, or Enterprise).
  </Card>

  <Card icon={<PlugIcon className="text-fd-primary" />} href="/onlyfans-ai/mcp/manus" title="Manus">
    <span className="font-medium text-fd-primary">Best for autonomous, scheduled agents.</span> Wake up to a finished revenue digest, churn rescue, or whale watch report.
  </Card>
</Cards>

## What you can do

A few things teams ship in the first week:

* **Daily revenue digest** — every morning, get last-24h earnings per creator in Slack-ready markdown
* **Churn rescue** — find subs lapsing in the next 7 days and draft reactivation DMs
* **Whale watch** — auto-tag fans spending over $200 and alert the assigned chatter
* **Chat backlog audit** — surface every chat with no reply in 24h, before fans unsub

<Callout>
  See more on the [OnlyFans MCP marketing page](https://onlyfansapi.com/mcp) — including the full tool catalog (350+ tools) and agency safety guidelines.
</Callout>

# Available webhook events (/webhooks/available-events)

<Callout title="Looking for a specific event?">
  Please reach out to us, we can add it!
</Callout>

## Accounts

### `accounts.connected`

A new OnlyFans account was connected.

<Callout>
  Please note that `payload.client_reference_id` can be null - it's only
  included if you provided us with `client_reference_id` while [Creating Client
  Session](/api-reference/client-sessions/create-client-session)
</Callout>

```json title="Example payload"
{
  "event": "accounts.connected",
  "account_id": "acct_123",
  "payload": {
    "client_reference_id": "my_crm_model_12345", // Optional - Value you provided while creating Client Session - otherwise null
    "state": "authenticated",
    "progress": "started",
    "latestAuthAttempt": {
      "started_at": "2025-05-13T20:26:56.000000Z",
      "completed_at": null,
      "success": false,
      "error_message": null,
      "needs_otp": false,
      "needs_face_otp": false,
      "otp_phone_ending": null
    }
  }
}
```

### `accounts.reconnected`

An OnlyFans account was reconnected.

```json title="Example payload"
{
  "event": "accounts.reconnected",
  "account_id": "acct_123",
  "payload": {
    "state": "authenticated",
    "progress": "started",
    "latestAuthAttempt": {
      "started_at": "2025-05-13T20:26:56.000000Z",
      "completed_at": null,
      "success": false,
      "error_message": null,
      "needs_otp": false,
      "needs_face_otp": false,
      "otp_phone_ending": null
    }
  }
}
```

### `accounts.session_expired`

OnlyFans account connection has expired, but we automatically re-connected it using our system - you don't need to do anything.

```json title="Example payload"
{
  "event": "accounts.session_expired",
  "account_id": "acct_123",
  "payload": {
    "state": "authenticated",
    "progress": "started",
    "latestAuthAttempt": {
      "started_at": "2025-05-13T20:26:56.000000Z",
      "completed_at": null,
      "success": false,
      "error_message": null,
      "needs_otp": false,
      "needs_face_otp": false,
      "otp_phone_ending": null
    }
  }
}
```

### `accounts.authentication_failed`

OnlyFans account connection has expired, and we couldn't automatically re-connect it using our system. You need to reconnect with our [/authenticate](/api-reference/connect-onlyfans-account/start-authentication) endpoint or manually in our [dashboard](https://app.onlyfansapi.com).

```json title="Example payload"
{
  "event": "accounts.authentication_failed",
  "account_id": "acct_123",
  "payload": {
    "state": "authenticated",
    "progress": "started",
    "latestAuthAttempt": {
      "started_at": "2025-05-13T20:26:56.000000Z",
      "completed_at": null,
      "success": false,
      "error_message": null,
      "needs_otp": false,
      "needs_face_otp": false,
      "otp_phone_ending": null
    }
  }
}
```

### `accounts.otp_code_required`

A two-factor authentication code is required to connect one of your OnlyFans accounts.

```json title="Example payload"
{
  "event": "accounts.otp_code_required",
  "account_id": "acct_123",
  "payload": {
    "state": "authenticated",
    "progress": "started",
    "latestAuthAttempt": {
      "started_at": "2025-05-13T20:26:56.000000Z",
      "completed_at": null,
      "success": false,
      "error_message": null,
      "needs_otp": false,
      "needs_face_otp": false,
      "otp_phone_ending": null
    }
  }
}
```

### `accounts.face_otp_required`

Face verification is required to connect one of your OnlyFans accounts.

```json title="Example payload"
{
  "event": "accounts.face_otp_required",
  "account_id": "acct_123",
  "payload": {
    "state": "authenticated",
    "progress": "started",
    "face_otp_verification_url": "https://id.onlyfans.com/s?123",
    "latestAuthAttempt": {
      "started_at": "2025-05-13T20:26:56.000000Z",
      "completed_at": null,
      "success": false,
      "error_message": null,
      "needs_otp": false,
      "needs_face_otp": false,
      "otp_phone_ending": null
    }
  }
}
```

## Transactions

### `transactions.new`

A new transaction has been received from a fan (eg. a subscription, a tip, a post, etc.).

<Callout type="info">
  Please note that this event may be delayed by up to 3 minutes.
</Callout>

| Supported `payload.type` values | Description                          |        |
| ------------------------------- | ------------------------------------ | ------ |
| `message`                       | A message has been sent to you       |        |
| `post`                          | Payment for a post                   | `post` |
| `tip`                           | Payment for a tip                    | `tip`  |
| `new_subscription`              | Payment for a new subscription       |        |
| `recurring_subscription`        | Payment for a recurring subscription |        |
| `stream`                        | Payment for a stream                 |        |
| `other`                         | Another type of transaction          |        |

```json title="Example payload"
{
  "event": "transactions.new",
  "account_id": "acct_123",
  "payload": {
    "id": "abc123",
    "created_at": "2026-01-01 00:00:00",
    "type": "message",
    "tips_source": null,
    "amount": 10,
    "vat_amount": 0,
    "tax_amount": 0,
    "net_amount": 8,
    "fee_amount": 2,
    "currency": "USD",
    "description": "Payment for message from \"<a href=\"https://onlyfans.com/johndoe\">John Doe</a>\"",
    "status": "loading",
    "fan": {
      "id": "123",
      "username": "johndoe",
      "name": "John Doe",
      "display_name": "",
      "avatar": null
    },
    "fanData": {
      "available": true,
      "last_updated_at": "2026-01-01T00:00:00.000000Z",
      "spending": {
        "total": 6.6,
        "messages": 10,
        "subscribes": 2.6,
        "posts": 0,
        "tips": 4,
        "streams": 0
      },
      "previous_reply_at": null
    }
  }
}
```

## Messages

### `messages.received`

New message received from a fan.

```json title="Example payload"
{
  "event": "messages.received",
  "account_id": "acct_123",
  "payload": {
    "responseType": "message",
    "text": "<p>Text</p>",
    "giphyId": null,
    "lockedText": false,
    "isFree": true,
    "price": 0,
    "isMediaReady": true,
    "mediaCount": 0,
    "media": [],
    "previews": [],
    "isTip": false,
    "isReportedByMe": false,
    "isCouplePeopleMedia": false,
    "queueId": 123,
    "isMarkdownDisabled": true,
    "fanData": {
      "available": true,
      "last_updated_at": "2025-10-23 00:52:34",
      "spending": {
        "total": 50,
        "messages": 30,
        "subscribes": 10,
        "posts": 0,
        "tips": 20,
        "streams": 0
      }
    },
    "fromUser": {
      "view": "s",
      "avatar": "https://example.com",
      "avatarThumbs": {
        "c50": "https://example.com",
        "c144": "https://example.com"
      },
      "header": null,
      "headerSize": null,
      "headerThumbs": null,
      "id": 123,
      "name": "Name",
      "username": "username",
      "canLookStory": true,
      "canCommentStory": true,
      "hasNotViewedStory": false,
      "isVerified": false,
      "canPayInternal": true,
      "hasScheduledStream": false,
      "hasStream": false,
      "hasStories": false,
      "tipsEnabled": false,
      "tipsTextEnabled": true,
      "tipsMin": 5,
      "tipsMinInternal": 1,
      "tipsMax": 200,
      "canEarn": false,
      "canAddSubscriber": false,
      "subscribePrice": 0,
      "displayName": "",
      "notice": "",
      "isRestricted": false,
      "canRestrict": true,
      "subscribedBy": true,
      "subscribedByExpire": false,
      "subscribedByExpireDate": "2034-12-22T00:38:29+00:00",
      "subscribedByAutoprolong": true,
      "subscribedIsExpiredNow": false,
      "currentSubscribePrice": 0,
      "subscribedOn": true,
      "subscribedOnExpiredNow": false,
      "subscribedOnDuration": "4 months",
      "listsStates": [
        {
          "id": "fans",
          "type": "fans",
          "name": "Fans",
          "hasUser": true,
          "canAddUser": false,
          "cannotAddUserReason": "ALREADY_EXISTS"
        },
        {
          "id": "following",
          "type": "following",
          "name": "Following",
          "hasUser": true,
          "canAddUser": false,
          "cannotAddUserReason": "ALREADY_EXISTS"
        },
        {
          "id": "recent",
          "type": "recent",
          "name": "Recent (last 24 hours)",
          "hasUser": false,
          "canAddUser": false,
          "cannotAddUserReason": "SYSTEM_LIST"
        },
        {
          "id": "muted",
          "type": "muted",
          "name": "Muted",
          "hasUser": false,
          "canAddUser": true,
          "cannotAddUserReason": null
        },
        {
          "id": "tagged",
          "type": "tagged",
          "name": "Tagged",
          "hasUser": false,
          "canAddUser": false,
          "cannotAddUserReason": "SYSTEM_LIST"
        },
        {
          "id": "friends",
          "type": "friends",
          "name": "Friends",
          "hasUser": false,
          "canAddUser": false,
          "cannotAddUserReason": "USER_NOT_PERFORMER"
        }
      ],
      "showMediaCount": true,
      "lastSeen": "2025-05-16T00:26:49+00:00",
      "canReport": true
    },
    "isFromQueue": false,
    "id": 123,
    "isOpened": false,
    "isNew": true,
    "createdAt": "2025-05-16T00:27:25+00:00",
    "changedAt": "2025-05-16T00:27:25+00:00",
    "cancelSeconds": 120,
    "isLiked": false,
    "canPurchase": false,
    "canPurchaseReason": "free",
    "canReport": true,
    "canBePinned": true,
    "isPinned": false,
    "replyToMessage": {
      "responseType": "message",
      "text": "<p>Text</p>",
      "giphyId": null,
      "lockedText": false,
      "isFree": true,
      "price": 0,
      "isMediaReady": true,
      "mediaCount": 0,
      "media": [],
      "previews": [],
      "isTip": false,
      "isReportedByMe": false,
      "isCouplePeopleMedia": false,
      "queueId": 123,
      "isMarkdownDisabled": true,
      "releaseForms": [],
      "fromUser": {
        "view": "s",
        "avatar": "https://example.com",
        "avatarThumbs": {
          "c50": "https://example.com",
          "c144": "https://example.com"
        },
        "header": "https://example.com",
        "headerSize": {
          "width": 4800,
          "height": 1440
        },
        "headerThumbs": {
          "w480": "https://example.com",
          "w760": "https://example.com"
        },
        "id": 123,
        "name": "Name",
        "username": "username",
        "canLookStory": true,
        "canCommentStory": true,
        "hasNotViewedStory": false,
        "isVerified": true,
        "canPayInternal": true,
        "hasScheduledStream": false,
        "hasStream": false,
        "hasStories": true,
        "tipsEnabled": true,
        "tipsTextEnabled": true,
        "tipsMin": 5,
        "tipsMinInternal": 1,
        "tipsMax": 200,
        "canEarn": true,
        "canAddSubscriber": false,
        "subscribePrice": 0,
        "hasStripe": false,
        "isStripeExist": false,
        "subscriptionBundles": [],
        "canSendChatToAll": true,
        "creditsMin": 10,
        "creditsMax": 200,
        "isPaywallPassed": true,
        "creditsMinAlternatives": 5,
        "canCreateLists": true,
        "showMediaCount": true,
        "lastSeen": "2025-05-16T00:24:06+00:00",
        "canReport": false,
        "subscribedOn": null
      },
      "isFromQueue": true,
      "canUnsendQueue": true,
      "unsendSecondsQueue": 1000000,
      "id": 123,
      "isOpened": false,
      "isNew": false,
      "createdAt": "2025-05-15T22:53:57+00:00",
      "changedAt": "2025-05-15T22:53:57+00:00",
      "cancelSeconds": 80792,
      "isLiked": false,
      "canPurchase": false,
      "canPurchaseReason": "free",
      "canReport": false,
      "canBePinned": true,
      "isPinned": false
    }
  }
}
```

### `messages.sent`

A new message has been sent from one of your OnlyFans accounts to a fan.

```json title="Example payload"
{
  "event": "messages.sent",
  "account_id": "acct_123",
  "payload": {
    "responseType": "message",
    "text": "<p>Text</p>",
    "giphyId": null,
    "lockedText": false,
    "isFree": true,
    "price": 0,
    "isMediaReady": true,
    "mediaCount": 1,
    "media": [
      {
        "id": 123,
        "type": "photo",
        "convertedToVideo": false,
        "canView": true,
        "hasError": false,
        "createdAt": "2025-04-05T06:19:31+00:00",
        "isReady": true,
        "files": {
          "full": {
            "url": "https://example.com",
            "width": 3840,
            "height": 5215,
            "size": 0,
            "sources": []
          },
          "thumb": {
            "url": "https://example.com",
            "width": 300,
            "height": 300,
            "size": 0
          },
          "preview": {
            "url": "https://example.com",
            "width": 960,
            "height": 1304,
            "size": 0
          },
          "squarePreview": {
            "url": "https://example.com",
            "width": 960,
            "height": 960,
            "size": 0
          }
        },
        "duration": 0,
        "releaseForms": [],
        "hasCustomPreview": false,
        "videoSources": {
          "240": null,
          "720": null
        }
      }
    ],
    "previews": [],
    "isTip": false,
    "isReportedByMe": false,
    "isCouplePeopleMedia": false,
    "queueId": 123,
    "isMarkdownDisabled": true,
    "releaseForms": [],
    "isFromQueue": false,
    "id": 123,
    "isOpened": false,
    "isNew": true,
    "createdAt": "2025-05-15T23:37:24+00:00",
    "changedAt": "2025-05-15T23:37:24+00:00",
    "cancelSeconds": 86400,
    "isLiked": false,
    "canPurchase": false,
    "canPurchaseReason": "free",
    "canReport": false,
    "canBePinned": true,
    "isPinned": false,
    "toUser": {
      "view": "s",
      "avatar": null,
      "avatarThumbs": null,
      "header": null,
      "headerSize": null,
      "headerThumbs": null,
      "id": 123,
      "name": "Name",
      "username": "username",
      "canLookStory": false,
      "canCommentStory": false,
      "hasNotViewedStory": false,
      "isVerified": false,
      "canPayInternal": true,
      "hasScheduledStream": false,
      "hasStream": false,
      "hasStories": false,
      "tipsEnabled": false,
      "tipsTextEnabled": true,
      "tipsMin": 5,
      "tipsMinInternal": 1,
      "tipsMax": 200,
      "canEarn": false,
      "canAddSubscriber": true,
      "subscribePrice": 0,
      "displayName": "",
      "notice": "",
      "isRestricted": false,
      "canRestrict": true,
      "subscribedBy": false,
      "subscribedByExpire": null,
      "subscribedByExpireDate": null,
      "subscribedByAutoprolong": null,
      "subscribedIsExpiredNow": null,
      "currentSubscribePrice": null,
      "subscribedOn": true,
      "subscribedOnExpiredNow": false,
      "subscribedOnDuration": "",
      "listsStates": [
        {
          "id": "fans",
          "type": "fans",
          "name": "Fans",
          "hasUser": true,
          "canAddUser": false,
          "cannotAddUserReason": "ALREADY_EXISTS"
        },
        {
          "id": "following",
          "type": "following",
          "name": "Following",
          "hasUser": false,
          "canAddUser": false,
          "cannotAddUserReason": "SYSTEM_LIST"
        },
        {
          "id": "recent",
          "type": "recent",
          "name": "Recent (last 24 hours)",
          "hasUser": true,
          "canAddUser": false,
          "cannotAddUserReason": "ALREADY_EXISTS"
        },
        {
          "id": "muted",
          "type": "muted",
          "name": "Muted",
          "hasUser": false,
          "canAddUser": true,
          "cannotAddUserReason": null
        },
        {
          "id": "tagged",
          "type": "tagged",
          "name": "Tagged",
          "hasUser": false,
          "canAddUser": false,
          "cannotAddUserReason": "SYSTEM_LIST"
        },
        {
          "id": "friends",
          "type": "friends",
          "name": "Friends",
          "hasUser": false,
          "canAddUser": false,
          "cannotAddUserReason": "USER_NOT_PERFORMER"
        }
      ],
      "showMediaCount": true,
      "lastSeen": "2025-05-15T23:37:03+00:00",
      "canReport": false
    }
  }
}
```

### `messages.ppv.unlocked`

A PPV message that you sent has been purchased by a fan.

```json title="Example payload"
{
  "event": "messages.ppv.unlocked",
  "account_id": "acct_123",
  "payload": {
    "id": "123",
    "type": "paided_message",
    "createdAt": "2025-05-05T22:18:00+00:00",
    "text": "has purchased your <a href='https://onlyfans.com/my/chats/chat/123?firstId=123'>message</a> for $5.00!",
    "replacePairs": {
      "{NAME}": "Name",
      "{MESSAGE_LINK}": "<a href='https://onlyfans.com/my/chats/chat/123?firstId=123'>message</a>",
      "{AMOUNT}": "$5.00"
    },
    "subType": "subscriber_pay_for_chat_message",
    "user_id": "123",
    "isRead": false,
    "canGoToProfile": true,
    "fanData": {
      "available": true,
      "last_updated_at": "2026-01-02 17:12:00",
      "spending": {
        "total": 6.6,
        "messages": 4,
        "subscribes": 2.6,
        "posts": 0,
        "tips": 4,
        "streams": 0
      }
    },
    "user": {
      "avatar": null,
      "avatarThumbs": null,
      "header": null,
      "headerSize": null,
      "headerThumbs": null,
      "id": 123,
      "name": "Name",
      "username": "username",
      "canLookStory": false,
      "canCommentStory": false,
      "hasNotViewedStory": false,
      "isVerified": false,
      "canPayInternal": false,
      "hasScheduledStream": false,
      "hasStream": false,
      "hasStories": false,
      "tipsEnabled": false,
      "tipsTextEnabled": true,
      "tipsMin": 5,
      "tipsMinInternal": 1,
      "tipsMax": 200,
      "canEarn": false,
      "canAddSubscriber": false,
      "subscribePrice": 0,
      "subscribedBy": false,
      "subscribedOn": false,
      "canReceiveChatMessage": false,
      "hideChat": false,
      "lastSeen": "2025-05-05T22:17:29+00:00",
      "isPerformer": false,
      "isRealPerformer": false,
      "view": "mn",
      "canReport": true,
      "subscribedByData": null,
      "subscribedOnData": null,
      "isBlocked": false
    }
  }
}
```

### `messages.deleted`

A chat message was deleted.

```json title="Example payload"
{
    "event": "messages.deleted",
    "account_id": "acct_123",
    "payload": {
        "id": "123"
    }
}
```

## Chat Queue

### `chat_queue.updated`

A queued message batch has been updated (e.g. progress change).

```json title="Example payload"
{
    "event": "chat_queue.updated",
    "account_id": "acct_123",
    "payload": {
        "id": 123,
        "date": "2025-01-01T00:00:00+00:00",
        "canUnsend": true,
        "hasError": false,
        "isCanceled": false,
        "isCouplePeopleMedia": false,
        "isDone": false,
        "isReady": true,
        "pending": 6,
        "total": 7,
        "unsendSeconds": 1000000
    }
}
```

### `chat_queue.finished`

A queued message batch has finished sending.

```json title="Example payload"
{
    "event": "chat_queue.finished",
    "account_id": "acct_123",
    "payload": {
        "id": 123,
        "date": "2025-01-01T00:00:00+00:00",
        "canUnsend": false,
        "hasError": false,
        "isCanceled": true,
        "isCouplePeopleMedia": false,
        "isDone": true,
        "isReady": true,
        "pending": 0,
        "total": 7,
        "unsendSeconds": 0
    }
}
```

## Tips

### `tips.received`

A new tip has been received from a fan.

```json title="Example payload"
{
    "event": "tips.received",
    "account_id": "acct_123",
    "payload": {
        "amountGross": 5,
        "amountNet": 4,
        "fanData": {
            "available": true,
            "last_updated_at": "2026-01-02 17:12:00",
            "spending": {
                "total": 6.6,
                "messages": 0,
                "subscribes": 2.6,
                "posts": 0,
                "tips": 4,
                "streams": 0
            }
        },
        "id": "123123123123",
        "type": "tip",
        "createdAt": "2026-01-02T17:12:00+00:00",
        "text": "paid you a tip of $5.00",
        "replacePairs": {
            "{SUBSCRIBER_LINK}": "<a href='https:\/\/onlyfans.com\/xxxxxxxx'>John Doe<\/a>",
            "{AMOUNT}": "$5.00",
            "{POST_BLOCK}": "",
            "{POST_DATA}": ""
        },
        "subType": "new_tips",
        "user_id": "9999999999",
        "isRead": false,
        "canGoToProfile": true,
        "user": {
            "avatar": "https:\/\/public.onlyfans.com\/files\/u\/uf\/ufs\/ufsXXXXXXXXXXXXX\/111111111\/avatar.jpg",
            "avatarThumbs": {
                "c50": "https:\/\/thumbs.onlyfans.com\/public\/files\/thumbs\/c50\/u\/uf\/ufs\/ufsXXXXXXXXXXXXX\/111111111\/avatar.jpg",
                "c144": "https:\/\/thumbs.onlyfans.com\/public\/files\/thumbs\/c144\/u\/uf\/ufs\/ufsXXXXXXXXXXXXX\/111111111\/avatar.jpg"
            },
            "header": "https:\/\/public.onlyfans.com\/files\/g\/g2\/g2e\/g2eXXXXXXXXXXXXXXX\/111111111\/header_image.jpg",
            "headerSize": {
                "width": 3362,
                "height": 1780
            },
            "headerThumbs": {
                "w480": "https:\/\/thumbs.onlyfans.com\/public\/files\/thumbs\/w480\/g\/g2\/g2e\/g2eXXXXXXXXXXXXXXX\/111111111\/header_image.jpg",
                "w760": "https:\/\/thumbs.onlyfans.com\/public\/files\/thumbs\/w760\/g\/g2\/g2e\/g2eXXXXXXXXXXXXXXX\/111111111\/header_image.jpg"
            },
            "id": 111111111,
            "name": "John Doe",
            "username": "johndoe",
            "canLookStory": false,
            "canCommentStory": false,
            "hasNotViewedStory": false,
            "isVerified": false,
            "canPayInternal": false,
            "hasScheduledStream": false,
            "hasStream": false,
            "hasStories": false,
            "tipsEnabled": false,
            "tipsTextEnabled": true,
            "tipsMin": 5,
            "tipsMinInternal": 1,
            "tipsMax": 200,
            "canEarn": false,
            "canAddSubscriber": false,
            "subscribePrice": 0,
            "subscribedBy": false,
            "subscribedOn": false,
            "canReceiveChatMessage": false,
            "hideChat": false,
            "lastSeen": "2026-01-02T17:09:46+00:00",
            "isPerformer": false,
            "isRealPerformer": false,
            "view": "mn",
            "canReport": true,
            "subscribedByData": null,
            "subscribedOnData": null,
            "isBlocked": false
        }
    }
}
```

## Subscriptions

### `subscriptions.new`

A new fan has subscribed.

```json title="Example payload"
{
  "event": "subscriptions.new",
  "account_id": "acct_123",
  "payload": {
    "id": "123",
    "type": "subscribed",
    "createdAt": "2025-05-05T21:27:00+00:00",
    "text": "subscribed to your profile!",
    "replacePairs": {
      "{SUBSCRIBER_LINK}": "<a href='https://onlyfans.com/username'>Name</a>",
      "{PRICE}": "free"
    },
    "subType": "new_subscriber",
    "user_id": "123",
    "isRead": false,
    "canGoToProfile": true,
    "fanData": {
      "available": true,
      "last_updated_at": "2026-01-02 17:12:00",
      "spending": {
        "total": 6.6,
        "messages": 0,
        "subscribes": 2.6,
        "posts": 0,
        "tips": 4,
        "streams": 0
      }
    },
    "user": {
      "avatar": "https://example.com",
      "avatarThumbs": {
        "c50": "https://example.com",
        "c144": "https://example.com"
      },
      "header": "https://example.com",
      "headerSize": {
        "width": 767,
        "height": 1152
      },
      "headerThumbs": {
        "w480": "https://example.com",
        "w760": "https://example.com"
      },
      "id": 123,
      "name": "Name",
      "username": "username",
      "canLookStory": false,
      "canCommentStory": false,
      "hasNotViewedStory": false,
      "isVerified": true,
      "canPayInternal": false,
      "hasScheduledStream": false,
      "hasStream": false,
      "hasStories": false,
      "tipsEnabled": true,
      "tipsTextEnabled": true,
      "tipsMin": 5,
      "tipsMinInternal": 1,
      "tipsMax": 200,
      "canEarn": true,
      "canAddSubscriber": false,
      "subscribePrice": 0,
      "subscribedBy": false,
      "subscribedOn": false,
      "canReceiveChatMessage": false,
      "hideChat": false,
      "lastSeen": "2025-05-05T21:26:04+00:00",
      "isPerformer": true,
      "isRealPerformer": true,
      "view": "mn",
      "canReport": true,
      "subscribedByData": null,
      "subscribedOnData": null,
      "isBlocked": false
    }
  }
}
```

### `subscriptions.renewed`

A fan has renewed their subscription.

```json title="Example data"
{
  "event": "subscriptions.renewed",
  "account_id": "acct_123",
  "payload": {
    "id": "123",
    "type": "subscribed",
    "createdAt": "2025-05-05T21:27:00+00:00",
    "text": "Good news! <a href='https://onlyfans.com/u34547118'>u34547118</a> has Just restarted their monthly subscription to your OnlyFans profile!",
    "replacePairs": {
      "{SUBSCRIBER_LINK}": "<a href='https://onlyfans.com/u34547118'>u34547118</a>",
      "{PRICE}": "$4.00"
    },
    "subType": "returning_subscriber",
    "user_id": "34547118",
    "isRead": false,
    "canGoToProfile": true,
    "fanData": {
      "available": true,
      "last_updated_at": "2026-01-02 17:12:00",
      "spending": {
        "total": 6.6,
        "messages": 0,
        "subscribes": 2.6,
        "posts": 0,
        "tips": 4,
        "streams": 0
      }
    },
    "user": {
      "avatar": "https://example.com",
      "avatarThumbs": {
        "c50": "https://example.com",
        "c144": "https://example.com"
      },
      "header": "https://example.com",
      "headerSize": {
        "width": 767,
        "height": 1152
      },
      "headerThumbs": {
        "w480": "https://example.com",
        "w760": "https://example.com"
      },
      "id": 34547118,
      "name": "Name",
      "username": "username",
      "canLookStory": false,
      "canCommentStory": false,
      "hasNotViewedStory": false,
      "isVerified": true,
      "canPayInternal": false,
      "hasScheduledStream": false,
      "hasStream": false,
      "hasStories": false,
      "tipsEnabled": true,
      "tipsTextEnabled": true,
      "tipsMin": 5,
      "tipsMinInternal": 1,
      "tipsMax": 200,
      "canEarn": true,
      "canAddSubscriber": false,
      "subscribePrice": 0,
      "subscribedBy": false,
      "subscribedOn": false,
      "canReceiveChatMessage": false,
      "hideChat": false,
      "lastSeen": "2025-05-05T21:26:04+00:00",
      "isPerformer": true,
      "isRealPerformer": true,
      "view": "mn",
      "canReport": true,
      "subscribedByData": null,
      "subscribedOnData": null,
      "isBlocked": false
    }
  }
}
```

## Posts

### `posts.liked`

A fan has liked one of your posts.

```json title="Example payload"
{
  "event": "posts.liked",
  "account_id": "acct_123",
  "payload": {
    "id": "123",
    "type": "favorited",
    "createdAt": "2025-05-05T22:22:00+00:00",
    "text": "liked your <a href='https://onlyfans.com/123/username'>post</a>",
    "replacePairs": {
      "{POST_LINK}": "<a href='https://onlyfans.com/123/username'>post</a>"
    },
    "subType": "new_favorite",
    "user_id": "123",
    "isRead": false,
    "canGoToProfile": true,
    "user": {
      "avatar": null,
      "avatarThumbs": null,
      "header": null,
      "headerSize": null,
      "headerThumbs": null,
      "id": 123,
      "name": "Name",
      "username": "username",
      "canLookStory": false,
      "canCommentStory": false,
      "hasNotViewedStory": false,
      "isVerified": false,
      "canPayInternal": false,
      "hasScheduledStream": false,
      "hasStream": false,
      "hasStories": false,
      "tipsEnabled": false,
      "tipsTextEnabled": true,
      "tipsMin": 5,
      "tipsMinInternal": 1,
      "tipsMax": 200,
      "canEarn": false,
      "canAddSubscriber": false,
      "subscribePrice": 0,
      "subscribedBy": false,
      "subscribedOn": false,
      "canReceiveChatMessage": false,
      "hideChat": false,
      "lastSeen": null,
      "isPerformer": false,
      "isRealPerformer": false,
      "view": "mn",
      "canReport": true,
      "subscribedByData": null,
      "subscribedOnData": null,
      "isBlocked": false
    }
  }
}
```

## Users

### `users.typing`

A fan is typing a message.

```json title="Example payload"
{
  "event": "users.typing",
  "account_id": "acct_123",
  "payload": {
    "id": 1910197
  }
}
```

### `users.online`

A fan was detected as online.

```json title="Example payload"
{
  "event": "users.online",
  "account_id": "acct_123",
  "payload": {
    "fan": {
      "id": "123",
      "username": "johndoe",
      "name": "John Doe",
      "display_name": "John Doe",
      "spending": {
        "messages": 10,
        "subscribes": 2.6,
        "posts": 0,
        "tips": 4,
        "streams": 0,
        "total": 16.6
      }
    },
    "observed_at": "2026-01-02T17:12:00.000000Z",
    "status_changed_at": "2026-01-02T17:12:00.000000Z",
    "last_seen_online_at": "2026-01-02T17:12:00.000000Z"
  }
}
```

### `users.offline`

A fan that was previously detected as online was detected as offline.

```json title="Example payload"
{
  "event": "users.offline",
  "account_id": "acct_123",
  "payload": {
    "fan": {
      "id": "123",
      "username": "johndoe",
      "name": "John Doe",
      "display_name": "John Doe",
      "spending": {
        "messages": 10,
        "subscribes": 2.6,
        "posts": 0,
        "tips": 4,
        "streams": 0,
        "total": 16.6
      }
    },
    "observed_at": "2026-01-02T17:42:00.000000Z",
    "status_changed_at": "2026-01-02T17:42:00.000000Z",
    "last_seen_online_at": "2026-01-02T17:12:00.000000Z"
  }
}
```

These events are detected by periodic online-status polling, so delivery is not instant. `users.online` is emitted when a tracked fan transitions from unknown/offline to online. `users.offline` is emitted when a fan that was previously detected online is no longer present in a successful online-status check.

## Data Exports

<Callout type="info">
  Data export webhook events are team-level events and do not include an `account_id` at the top level. Instead, the `account_ids` array is included in the payload.
</Callout>

### `data_exports.calculating_credits`

Credit calculation has started for a data export.

```json title="Example payload"
{
  "event": "data_exports.calculating_credits",
  "payload": {
    "id": "data_export_abc123",
    "type": "transactions",
    "status": "calculating_credits",
    "file_type": "csv",
    "credit_cost": null,
    "start_date": "2025-01-01T00:00:00+00:00",
    "end_date": "2025-01-31T23:59:59+00:00",
    "account_ids": ["acct_123", "acct_456"],
    "created_at": "2025-05-13T20:26:56+00:00"
  }
}
```

### `data_exports.calculating_credits_completed`

Credit calculation has completed successfully for a data export.

```json title="Example payload"
{
  "event": "data_exports.calculating_credits_completed",
  "payload": {
    "id": "data_export_abc123",
    "type": "transactions",
    "status": "calculating_credits_completed",
    "file_type": "csv",
    "credit_cost": 150,
    "start_date": "2025-01-01T00:00:00+00:00",
    "end_date": "2025-01-31T23:59:59+00:00",
    "account_ids": ["acct_123", "acct_456"],
    "created_at": "2025-05-13T20:26:56+00:00"
  }
}
```

### `data_exports.calculating_credits_failed`

Credit calculation has failed for a data export.

```json title="Example payload"
{
  "event": "data_exports.calculating_credits_failed",
  "payload": {
    "id": "data_export_abc123",
    "type": "transactions",
    "status": "calculating_credits_failed",
    "file_type": "csv",
    "credit_cost": null,
    "start_date": "2025-01-01T00:00:00+00:00",
    "end_date": "2025-01-31T23:59:59+00:00",
    "account_ids": ["acct_123", "acct_456"],
    "created_at": "2025-05-13T20:26:56+00:00"
  }
}
```

### `data_exports.in_progress`

A data export is now in progress.

```json title="Example payload"
{
  "event": "data_exports.in_progress",
  "payload": {
    "id": "data_export_abc123",
    "type": "transactions",
    "status": "in_progress",
    "file_type": "csv",
    "credit_cost": 150,
    "start_date": "2025-01-01T00:00:00+00:00",
    "end_date": "2025-01-31T23:59:59+00:00",
    "account_ids": ["acct_123", "acct_456"],
    "created_at": "2025-05-13T20:26:56+00:00"
  }
}
```

### `data_exports.completed`

A data export has completed successfully. The payload includes a temporary download URL that expires after 1 hour.

```json title="Example payload"
{
  "event": "data_exports.completed",
  "payload": {
    "id": "data_export_abc123",
    "type": "transactions",
    "status": "completed",
    "file_type": "csv",
    "credit_cost": 150,
    "start_date": "2025-01-01T00:00:00+00:00",
    "end_date": "2025-01-31T23:59:59+00:00",
    "account_ids": ["acct_123", "acct_456"],
    "created_at": "2025-05-13T20:26:56+00:00",
    "download_url": "https://example-bucket.s3.amazonaws.com/data-exports/team-slug/data_export_abc123xyz789.csv?X-Amz-Signature=...",
    "download_url_expires_at": "2025-05-13T21:26:56+00:00"
  }
}
```

### `data_exports.failed`

A data export has failed. The `failed_reason` field is only included when the failure was due to insufficient credits.

```json title="Example payload"
{
  "event": "data_exports.failed",
  "payload": {
    "id": "data_export_abc123",
    "type": "transactions",
    "status": "failed",
    "file_type": "csv",
    "credit_cost": 150,
    "start_date": "2025-01-01T00:00:00+00:00",
    "end_date": "2025-01-31T23:59:59+00:00",
    "account_ids": ["acct_123", "acct_456"],
    "created_at": "2025-05-13T20:26:56+00:00",
    "failed_reason": "Insufficient credits: 150 required"
  }
}
```

### `data_exports.cancelled`

A data export was cancelled.

```json title="Example payload"
{
  "event": "data_exports.cancelled",
  "payload": {
    "id": "data_export_abc123",
    "type": "transactions",
    "status": "cancelled",
    "file_type": "csv",
    "credit_cost": 150,
    "start_date": "2025-01-01T00:00:00+00:00",
    "end_date": "2025-01-31T23:59:59+00:00",
    "account_ids": ["acct_123", "acct_456"],
    "created_at": "2025-05-13T20:26:56+00:00"
  }
}
```

## Fan Summary

### `fan_summary.completed`

An AI Fan Profile Summary has finished generating. This event fires for both new summaries and regenerations, and is dispatched after the summary completes successfully.

```json title="Example payload"
{
  "event": "fan_summary.completed",
  "data": {
    "fan": {
      "onlyfans_id": 123456789,
      "username": "example_fan"
    },
    "summary": {
      "status": "completed",
      "summary_data": {
        "name": "Jane Doe",
        "preferred_name": "Jane",
        "family_pets": "Has a golden retriever named Max",
        "travel_plans": "Planning a trip to Bali",
        "kinks": "",
        "hobbies": "Yoga, photography",
        "content_preferences": "Behind the scenes content",
        "themes": "",
        "requests": "",
        "interests": "Fitness, travel",
        "other_notes": ""
      },
      "analyzed_message_count": 504,
      "last_analyzed_at": "2026-03-19T12:00:00+00:00"
    }
  }
}
```

# Webhooks (/webhooks)

import Link from "next/link";
import { SiMake, SiN8n, SiZapier } from "@icons-pack/react-simple-icons";

<div className="grid grid-cols-1 md:grid-cols-2 md:gap-4">
  <Callout title="Webhooks are for everyone!" type="success">
    All types of webhook events are available on every plan - Basic, Pro and Enterprise.

    <ul>
      <li>
        <Link href="/webhooks/subscribing-to-webhooks" className="text-fd-primary">How to Subscribe to webhooks</Link>
      </li>

      <li>
        <Link href="/webhooks/available-events" className="text-fd-primary">List of available webhook events</Link>
      </li>
    </ul>
  </Callout>

  <Callout title="Prefer no-code?">
    We offer native integrations for most no-code tools. Get started in minutes without writing a single line of code.

    <Link className="flex gap-2" href="/integrations/n8n">
      <SiN8n color="default" size={24} />

       n8n integration
    </Link>

    <Link className="flex gap-2" href="/integrations/make">
      <SiMake color="default" size={24} />

       Make.com integration
    </Link>

    <Link className="flex gap-2" href="/integrations/zapier">
      <SiZapier color="default" size={24} />

       Zapier integration
    </Link>
  </Callout>
</div>

A webhook is an HTTP endpoint that receives events from OnlyFans API. They allow you to be notified about events such as:

* Receiving a message from a fan ([`messages.received`](/webhooks/available-events#messagesreceived))
* New fan subscriptions ([`subscriptions.new`](/webhooks/available-events#subscriptionsnew))
* Fan has renewed their subscription ([`subscriptions.renewed`](/webhooks/available-events#subscriptionsrenewed))
* Fan purchased a PPV message ([`messages.ppv.unlocked`](/webhooks/available-events#messagesppvunlocked))
* And more! See a [complete list of available webhook events](/webhooks/available-events)

You can use our API for less frequent actions like retrieving specific chats, profiles, or earning details, while webhooks help you scale your integration and process large volumes of business-critical events in near real-time.

# Protecting your webhooks (/webhooks/protecting-your-webhooks)

<Callout>
  You can choose any signing secret, but it is recommended to use a long, random string.
</Callout>

## How the signature is calculated

We calculate the signature using the HMAC SHA256 algorithm. The payload (as json) is the string, and the signing secret is the key.

## Verifying the signature

Below you can find examples of how to verify the signature in different programming languages.

<CodeBlockTabs defaultValue="PHP">
  <CodeBlockTabsList>
    <CodeBlockTabsTrigger value="PHP">
      PHP
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="Python">
      Python
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="JavaScript">
      JavaScript
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="Go">
      Go
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="Java">
      Java
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="Ruby">
      Ruby
    </CodeBlockTabsTrigger>
  </CodeBlockTabsList>

  <CodeBlockTab value="PHP">
    ```php
    $computedSignature = hash_hmac('sha256', $requestContent, $signingSecret);
    ```
  </CodeBlockTab>

  <CodeBlockTab value="Python">
    ```python
    import hmac
    import hashlib

    computed_signature = hmac.new(signing_secret.encode(), request_content.encode(), hashlib.sha256).hexdigest()
    ```
  </CodeBlockTab>

  <CodeBlockTab value="JavaScript">
    ```javascript
    const crypto = require('crypto');

    const computedSignature = crypto
        .createHmac('sha256', signingSecret)
        .update(requestContent)
        .digest('hex');
    ```
  </CodeBlockTab>

  <CodeBlockTab value="Go">
    ```go
    package main

    import (
        "crypto/hmac"
        "crypto/sha256"
        "encoding/hex"
    )

    func main() {
        signingSecret := []byte("your_signing_secret")
        requestContent := []byte("your_request_content")

        h := hmac.New(sha256.New, signingSecret)
        h.Write(requestContent)
        computedSignature := hex.EncodeToString(h.Sum(nil))

        // Use `computedSignature` as needed
    }
    ```
  </CodeBlockTab>

  <CodeBlockTab value="Java">
    ```java
    import javax.crypto.Mac;
    import javax.crypto.spec.SecretKeySpec;
    import java.util.Base64;
    import java.nio.charset.StandardCharsets;

    public class HmacSha256Example {
        public static void main(String[] args) throws Exception {
            String signingSecret = "your_signing_secret";
            String requestContent = "your_request_content";

            Mac mac = Mac.getInstance("HmacSHA256");
            SecretKeySpec secretKeySpec = new SecretKeySpec(signingSecret.getBytes(StandardCharsets.UTF_8), "HmacSHA256");
            mac.init(secretKeySpec);

            byte[] hmacBytes = mac.doFinal(requestContent.getBytes(StandardCharsets.UTF_8));
            String computedSignature = bytesToHex(hmacBytes);

            // Use `computedSignature` as needed
        }

        private static String bytesToHex(byte[] bytes) {
            StringBuilder hexString = new StringBuilder();
            for (byte b : bytes) {
                String hex = Integer.toHexString(0xff & b);
                if (hex.length() == 1) {
                    hexString.append('0');
                }
                hexString.append(hex);
            }
            return hexString.toString();
        }
    }
    ```
  </CodeBlockTab>

  <CodeBlockTab value="Ruby">
    ```ruby
    require 'openssl'

    computed_signature = OpenSSL::HMAC.hexdigest('sha256', signing_secret, request_content)
    ```
  </CodeBlockTab>
</CodeBlockTabs>

# Subscribing to webhooks (/webhooks/subscribing-to-webhooks)

You can easily subscribe to webhooks using our console. To do this, follow these steps:

1. Go to the [OnlyFans API Console -> Webhooks](https://app.onlyfansapi.com)
2. Click on the **+ Add Webhook** button
3. Fill in the **Endpoint URL** field with your webhook endpoint
4. Optionally, add a [Signing Secret](/webhooks/protecting-your-webhooks) to verify the webhook payloads (recommended)
5. Select the [events](/webhooks/available-events) you want to subscribe to

<img alt="Add Webhook" src={__img0} placeholder="blur" />

Once you have added your webhook, you will start receiving events on your webhook endpoint.
You will be able to view the latest response status in the console.

# Fansly API Overview (/api-reference/fansly)

import { MailIcon } from "lucide-react";

## What to expect

We're bringing the same developer experience you know from our OnlyFans API to Fansly: consistent authentication, predictable responses, and broad coverage across messaging, fans, media, and more.

Browse the endpoints in the sidebar to preview what's coming. Keep in mind that during closed beta:

* Endpoints may be added, changed, or removed without notice.
* Access is currently limited to approved beta participants.

## Want early access?

We're onboarding a limited number of partners during the closed beta.

<Cards>
  <Card icon={<MailIcon />} title="Request closed beta access" href="mailto:hello@onlyfansapi.com?subject=Fansly%20API%20closed%20beta%20access">
    Reach out and let us know about your use case.
  </Card>
</Cards>

# Next.js & Prisma (/auth/examples/nextjs-prisma)

## Overview

This guide walks you through building a complete account management dashboard that:

* Authenticates OnlyFans accounts using `@onlyfansapi/auth`
* Stores account data in a PostgreSQL database via Prisma
* Provides a UI to view and manage connected accounts

<Callout title="Example Repository">
  The complete source code is available at [auth-example-nextjs-prisma](https://github.com/onlyfansapi/auth-example-nextjs-prisma).
</Callout>

## Prerequisites

Before starting, ensure you have:

* Node.js 18+ or Bun installed
* A PostgreSQL database
* An OnlyFans API key from [app.onlyfansapi.com/api-keys](https://app.onlyfansapi.com/api-keys)

## Step 1: Create a Next.js Project

Create a new Next.js project with TypeScript and Tailwind CSS:

```bash
npx create-next-app@latest my-app --typescript --tailwind --app
cd my-app
```

## Step 2: Install Dependencies

Install the required packages:

```bash
npm install @onlyfansapi/auth prisma @prisma/client @prisma/adapter-pg pg
```

## Step 3: Set Up Prisma

Initialize Prisma with PostgreSQL:

```bash
npx prisma init
```

Update your `prisma/schema.prisma` to define the Account model:

```prisma
generator client {
  provider = "prisma-client"
}

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

model Account {
  id          String   @id @default(cuid())
  accountId   String   @unique  // OnlyFans account ID
  username    String             // OnlyFans username
  displayName String             // User-defined label
  name        String?            // OnlyFans profile name
  avatar      String?            // Avatar URL
  createdAt   DateTime @default(now())
  updatedAt   DateTime @updatedAt
}
```

Create the Prisma client singleton in `lib/prisma.ts`:

```typescript
import { Pool } from "pg";
import { PrismaPg } from "@prisma/adapter-pg";
import { PrismaClient } from "@prisma/client";

const globalForPrisma = globalThis as unknown as { prisma?: PrismaClient };

function createPrismaClient() {
  const pool = new Pool({ connectionString: process.env.DATABASE_URL });
  const adapter = new PrismaPg(pool);
  return new PrismaClient({ adapter });
}

export const prisma = globalForPrisma.prisma ?? createPrismaClient();

if (process.env.NODE_ENV !== "production") {
  globalForPrisma.prisma = prisma;
}
```

## Step 4: Configure Environment Variables

Create a `.env` file with your credentials:

```bash
# PostgreSQL connection string
DATABASE_URL="postgresql://user:password@localhost:5432/mydb"

# OnlyFans API Key (keep this secret, server-side only)
OFAPI_API_KEY="ofapi_..."
```

<Callout title="Security Note" type="warn">
  The `OFAPI_API_KEY` should never be exposed to the client. We'll create a server-side endpoint to generate client session tokens.
</Callout>

## Step 5: Create the Client Session API Route

Create `app/api/client-session/route.ts` to securely generate client session tokens:

```typescript
import { NextRequest, NextResponse } from "next/server";

export async function POST(request: NextRequest) {
  const body = await request.json();
  const { displayName } = body;

  if (!displayName) {
    return NextResponse.json(
      { error: "displayName is required" },
      { status: 400 }
    );
  }

  const apiKey = process.env.OFAPI_API_KEY;
  if (!apiKey) {
    return NextResponse.json(
      { error: "API key not configured" },
      { status: 500 }
    );
  }

  // Create client session via OnlyFans API
  const response = await fetch(
    "https://app.onlyfansapi.com/api/client-sessions",
    {
      method: "POST",
      headers: {
        "Content-Type": "application/json",
        Authorization: `Bearer ${apiKey}`,
      },
      body: JSON.stringify({ display_name: displayName }),
    }
  );

  if (!response.ok) {
    return NextResponse.json(
      { error: "Failed to create client session" },
      { status: response.status }
    );
  }

  const data = await response.json();
  return NextResponse.json({ token: data.data.token });
}
```

This endpoint calls the [Create Client Session](/api-reference/client-sessions/create-client-session) API to generate a temporary token for authentication.

## Step 6: Create the Accounts API Routes

Create `app/api/accounts/route.ts` for listing and creating accounts:

```typescript
import { NextRequest, NextResponse } from "next/server";
import { prisma } from "@/lib/prisma";

export async function GET() {
  const accounts = await prisma.account.findMany({
    orderBy: { createdAt: "desc" },
  });
  return NextResponse.json(accounts);
}

export async function POST(request: NextRequest) {
  const { accountId, username, displayName, name, avatar } = await request.json();

  if (!accountId || !username || !displayName) {
    return NextResponse.json(
      { error: "accountId, username, and displayName are required" },
      { status: 400 }
    );
  }

  const account = await prisma.account.create({
    data: { accountId, username, displayName, name, avatar },
  });

  return NextResponse.json(account, { status: 201 });
}
```

Create `app/api/accounts/[id]/route.ts` for deleting accounts:

```typescript
import { NextRequest, NextResponse } from "next/server";
import { prisma } from "@/lib/prisma";

export async function DELETE(
  request: NextRequest,
  { params }: { params: Promise<{ id: string }> }
) {
  const { id } = await params;
  await prisma.account.delete({ where: { id } });
  return NextResponse.json({ success: true });
}
```

## Step 7: Build the Dashboard UI

Create a dashboard page in `app/page.tsx` that uses the auth package:

```tsx
"use client";

import { useState } from "react";
import { startOnlyFansAuthentication } from "@onlyfansapi/auth";

export default function Dashboard() {
  const [displayName, setDisplayName] = useState("");
  const [isLoading, setIsLoading] = useState(false);

  const handleAddAccount = async () => {
    if (!displayName.trim()) return;

    setIsLoading(true);

    try {
      // Step 1: Get client session token from our backend
      const sessionRes = await fetch("/api/client-session", {
        method: "POST",
        headers: { "Content-Type": "application/json" },
        body: JSON.stringify({ displayName: displayName.trim() }),
      });

      if (!sessionRes.ok) throw new Error("Failed to create session");

      const { token } = await sessionRes.json();

      // Step 2: Start authentication with the token
      startOnlyFansAuthentication(token, {
        onSuccess: async (data) => {
          // Step 3: Save account to database
          await fetch("/api/accounts", {
            method: "POST",
            headers: { "Content-Type": "application/json" },
            body: JSON.stringify({
              accountId: data.accountId,
              username: data.username,
              displayName: displayName.trim(),
              name: data.onlyfansData?.name,
              avatar: data.onlyfansData?.avatar_url,
            }),
          });

          // Refresh account list or show success message
          window.location.reload();
        },
        onError: (error) => {
          console.error("Authentication failed:", error.message);
          setIsLoading(false);
        },
      });
    } catch (error) {
      console.error("Error:", error);
      setIsLoading(false);
    }
  };

  return (
    <div>
      <h1>Account Dashboard</h1>

      <input
        type="text"
        value={displayName}
        onChange={(e) => setDisplayName(e.target.value)}
        placeholder="Enter display name"
      />

      <button onClick={handleAddAccount} disabled={isLoading}>
        {isLoading ? "Connecting..." : "Add Account"}
      </button>
    </div>
  );
}
```

## Step 8: Initialize the Database

Generate the Prisma client and push the schema to your database:

```bash
npx prisma generate
npx prisma db push
```

## Step 9: Run the Application

Start the development server:

```bash
npm run dev
```

Open [http://localhost:3000](http://localhost:3000) to see your dashboard.

## Authentication Flow Summary

<Mermaid
  chart="sequenceDiagram
    participant User
    participant Backend as Backend<br/>/api/client-session
    participant OFAPI as OnlyFans API
    participant Auth as @onlyfansapi/auth
    participant Popup as Auth Popup
    participant DB as Database (Prisma)

    User->>Backend: Click &#x22;Add Account&#x22;
    Backend->>OFAPI: POST /api/client-sessions
    OFAPI-->>Backend: token (ofapi_cs_...)
    Backend->>Auth: startOnlyFansAuthentication(token)
    Auth->>Popup: Open authentication popup
    Popup->>Popup: User logs in
    Popup-->>Auth: onSuccess(data)
    Auth->>Backend: POST /api/accounts
    Backend->>DB: Save account
    DB-->>User: Account connected!"
/>

1. **User initiates auth**: Clicks "Add Account" and enters a display name
2. **Backend creates session**: Server calls OnlyFans API to create a client session token
3. **Auth popup opens**: `startOnlyFansAuthentication()` opens a secure popup
4. **User authenticates**: User logs into their OnlyFans account
5. **Callback fires**: `onSuccess` receives account data
6. **Account saved**: Backend stores account in database via Prisma

## Best Practices

### Keep API Keys Server-Side

Never expose your `OFAPI_API_KEY` to the client. Always create client session tokens via a server-side API route.

```typescript
// ✅ Good: Server-side token generation
const response = await fetch("/api/client-session", { ... });

// ❌ Bad: Client-side API key usage
startOnlyFansAuthentication("ofapi_...", { ... });
```

### Handle Duplicate Accounts

Check for existing accounts before creating:

```typescript
const existing = await prisma.account.findUnique({
  where: { accountId: data.accountId },
});

if (existing) {
  // Update existing account or show error
}
```

### Store Display Names

The `displayName` field helps users identify accounts in your dashboard:

```typescript
body: JSON.stringify({
  accountId: data.accountId,
  username: data.username,
  displayName: "Agency / Model: Stella", // User-defined label
})
```

## TypeScript Support

The auth package includes full TypeScript definitions:

```typescript
import {
  startOnlyFansAuthentication,
  AuthSuccessData,
  AuthFailureError
} from "@onlyfansapi/auth";

startOnlyFansAuthentication(token, {
  onSuccess: (data: AuthSuccessData) => {
    console.log(data.accountId);  // string
    console.log(data.username);   // string
    console.log(data.onlyfansData.name); // string
  },
  onError: (error: AuthFailureError) => {
    console.log(error.message);   // string
  },
});
```

## Next Steps

* **Add webhooks**: Listen for account events via [Webhooks](/webhooks)
* **Explore the API**: Use account credentials for [API calls](/api-reference)
* **View example repo**: See the complete implementation at [auth-example-nextjs-prisma](https://github.com/onlyfansapi/auth-example-nextjs-prisma)

## Related Resources

* [Installation Guide](/auth/installation)
* [Quick Start](/auth/quickstart)
* [Create Client Session API](/api-reference/client-sessions/create-client-session)
* [API Reference](/api-reference)

# Available modules (/integrations/make/available-modules)

<Callout title="Looking for a specific module?">
  Please reach out to us, we can add it!
</Callout>

## Instant Triggers

An Instant Trigger (also known as a "webhook"), is a module that is executed immediately when an event occurs.

### 🤑 Chat Message PPV Purchased

A PPV (pay-per-view) message that you sent has been purchased by a fan

```json title="Example data"
{
  "event": "messages.ppv.unlocked",
  "account_id": "acct_123",
  "payload": {
    "id": "123",
    "type": "paided_message",
    "createdAt": "2025-05-05T22:18:00+00:00",
    "text": "has purchased your <a href='https://onlyfans.com/my/chats/chat/123?firstId=123'>message</a> for $5.00!",
    "replacePairs": {
      "{NAME}": "Name",
      "{MESSAGE_LINK}": "<a href='https://onlyfans.com/my/chats/chat/123?firstId=123'>message</a>",
      "{AMOUNT}": "$5.00"
    },
    "subType": "subscriber_pay_for_chat_message",
    "user_id": "123",
    "isRead": false,
    "canGoToProfile": true,
    "user": {
      "avatar": null,
      "avatarThumbs": null,
      "header": null,
      "headerSize": null,
      "headerThumbs": null,
      "id": 123,
      "name": "Name",
      "username": "username",
      "canLookStory": false,
      "canCommentStory": false,
      "hasNotViewedStory": false,
      "isVerified": false,
      "canPayInternal": false,
      "hasScheduledStream": false,
      "hasStream": false,
      "hasStories": false,
      "tipsEnabled": false,
      "tipsTextEnabled": true,
      "tipsMin": 5,
      "tipsMinInternal": 1,
      "tipsMax": 200,
      "canEarn": false,
      "canAddSubscriber": false,
      "subscribePrice": 0,
      "subscribedBy": false,
      "subscribedOn": false,
      "canReceiveChatMessage": false,
      "hideChat": false,
      "lastSeen": "2025-05-05T22:17:29+00:00",
      "isPerformer": false,
      "isRealPerformer": false,
      "view": "mn",
      "canReport": true,
      "subscribedByData": null,
      "subscribedOnData": null,
      "isBlocked": false
    }
  }
}
```

### 📥 Chat Message Received

A new chat message has been received.

```json title="Example data"
{
  "event": "messages.received",
  "account_id": "acct_abc123",
  "payload": {
    "responseType": "message",
    "text": "<p>Text</p>",
    "giphyId": null,
    "lockedText": false,
    "isFree": true,
    "price": 0,
    "isMediaReady": true,
    "mediaCount": 0,
    "media": [],
    "previews": [],
    "isTip": false,
    "isReportedByMe": false,
    "isCouplePeopleMedia": false,
    "queueId": 123,
    "isMarkdownDisabled": true,
    "fromUser": {
      "view": "s",
      "avatar": "https://public.onlyfans.com/files/.../avatar.jpg",
      "avatarThumbs": {
        "c50": "https://thumbs.onlyfans.com/public/files/thumbs/c50/.../avatar.jpg",
        "c144": "https://thumbs.onlyfans.com/public/files/thumbs/c144/.../avatar.jpg"
      },
      "header": "https://public.onlyfans.com/files/f/fn/fni/.../header.jpg",
      "headerSize": {
        "width": 4000,
        "height": 3000
      },
      "headerThumbs": {
        "w480": "https://thumbs.onlyfans.com/public/files/thumbs/w480/f/fn/fni/.../header.jpg",
        "w760": "https://thumbs.onlyfans.com/public/files/thumbs/w760/f/fn/fni/.../header.jpg"
      },
      "id": 123,
      "name": "Name",
      "username": "username",
      "canLookStory": true,
      "canCommentStory": true,
      "hasNotViewedStory": false,
      "isVerified": false,
      "canPayInternal": true,
      "hasScheduledStream": false,
      "hasStream": false,
      "hasStories": false,
      "tipsEnabled": false,
      "tipsTextEnabled": true,
      "tipsMin": 5,
      "tipsMinInternal": 1,
      "tipsMax": 200,
      "canEarn": false,
      "canAddSubscriber": false,
      "subscribePrice": 0,
      "displayName": "Name",
      "notice": "",
      "isRestricted": false,
      "canRestrict": true,
      "subscribedBy": true,
      "subscribedByExpire": false,
      "subscribedByExpireDate": "2025-01-01T01:11:11+00:00",
      "subscribedByAutoprolong": true,
      "subscribedIsExpiredNow": false,
      "currentSubscribePrice": 0,
      "subscribedOn": null,
      "subscribedOnExpiredNow": true,
      "subscribedOnDuration": "1 month",
      "listsStates": [
        {
          "id": "friends",
          "type": "friends",
          "name": "Amigos",
          "hasUser": false,
          "canAddUser": false,
          "cannotAddUserReason": "USER_NOT_PERFORMER"
        },
        {
          "id": "muted",
          "type": "muted",
          "name": "Enmudecido",
          "hasUser": false,
          "canAddUser": true,
          "cannotAddUserReason": null
        },
        {
          "id": "tagged",
          "type": "tagged",
          "name": "etiquetado",
          "hasUser": false,
          "canAddUser": false,
          "cannotAddUserReason": "SYSTEM_LIST"
        },
        {
          "id": "rebill_on",
          "type": "rebill_on",
          "name": "Renovación de Facturación",
          "hasUser": false,
          "canAddUser": false,
          "cannotAddUserReason": null
        },
        {
          "id": "recent",
          "type": "recent",
          "name": "Reciente (últimas 24 horas)",
          "hasUser": false,
          "canAddUser": false,
          "cannotAddUserReason": "SYSTEM_LIST"
        },
        {
          "id": "fans",
          "type": "fans",
          "name": "Fans",
          "hasUser": false,
          "canAddUser": false,
          "cannotAddUserReason": null
        },
        {
          "id": "rebill_off",
          "type": "rebill_off",
          "name": "Apagar Facturación",
          "hasUser": false,
          "canAddUser": false,
          "cannotAddUserReason": null
        },
        {
          "id": "following",
          "type": "following",
          "name": "Siguiente",
          "hasUser": true,
          "canAddUser": false,
          "cannotAddUserReason": "ALREADY_EXISTS"
        }
      ],
      "showMediaCount": true,
      "lastSeen": "2025-01-01T01:11:11+00:0000",
      "canReport": true
    },
    "isFromQueue": false,
    "id": 123,
    "isOpened": false,
    "isNew": true,
    "createdAt": "2025-01-01T01:11:11+00:00",
    "changedAt": "2025-01-01T01:11:11+00:00",
    "cancelSeconds": 119,
    "isLiked": false,
    "canPurchase": false,
    "canPurchaseReason": "free",
    "canReport": true,
    "canBePinned": true,
    "isPinned": false
  }
}
```

### 📤 Chat Message Sent

A new message has been sent from one of your OnlyFans accounts to a fan.

```json title="Example data"
{
  "event": "messages.sent",
  "account_id": "acct_abc123",
  "payload": {
    "responseType": "message",
    "text": "<p>Text</p>",
    "giphyId": null,
    "lockedText": true,
    "isFree": true,
    "price": 0,
    "isMediaReady": true,
    "mediaCount": 0,
    "media": [],
    "previews": [],
    "isTip": false,
    "isReportedByMe": false,
    "isCouplePeopleMedia": false,
    "queueId": 123,
    "isMarkdownDisabled": true,
    "releaseForms": [],
    "isFromQueue": false,
    "id": 123,
    "isOpened": false,
    "isNew": true,
    "createdAt": "2025-07-02T00:00:00+00:00",
    "changedAt": "2025-07-02T00:00:00+00:00",
    "cancelSeconds": 86400,
    "isLiked": false,
    "canPurchase": false,
    "canPurchaseReason": "free",
    "canReport": false,
    "canBePinned": true,
    "isPinned": false,
    "toUser": {
      "view": "s",
      "avatar": null,
      "avatarThumbs": null,
      "header": null,
      "headerSize": null,
      "headerThumbs": null,
      "id": 123,
      "name": "Name",
      "username": "username",
      "canLookStory": false,
      "canCommentStory": false,
      "hasNotViewedStory": false,
      "isVerified": false,
      "canPayInternal": true,
      "hasScheduledStream": false,
      "hasStream": false,
      "hasStories": false,
      "tipsEnabled": false,
      "tipsTextEnabled": true,
      "tipsMin": 5,
      "tipsMinInternal": 1,
      "tipsMax": 200,
      "canEarn": false,
      "canAddSubscriber": true,
      "subscribePrice": 0,
      "displayName": "",
      "notice": "",
      "isRestricted": false,
      "canRestrict": true,
      "subscribedBy": false,
      "subscribedByExpire": null,
      "subscribedByExpireDate": null,
      "subscribedByAutoprolong": null,
      "subscribedIsExpiredNow": null,
      "currentSubscribePrice": null,
      "subscribedOn": true,
      "subscribedOnExpiredNow": false,
      "subscribedOnDuration": "1 month",
      "listsStates": [
        {
          "id": "friends",
          "type": "friends",
          "name": "Friends",
          "hasUser": false,
          "canAddUser": false,
          "cannotAddUserReason": "USER_NOT_PERFORMER"
        },
        {
          "id": "muted",
          "type": "muted",
          "name": "Muted",
          "hasUser": false,
          "canAddUser": true,
          "cannotAddUserReason": null
        },
        {
          "id": "tagged",
          "type": "tagged",
          "name": "Tagged",
          "hasUser": false,
          "canAddUser": false,
          "cannotAddUserReason": "SYSTEM_LIST"
        },
        {
          "id": "rebill_on",
          "type": "rebill_on",
          "name": "Renew On",
          "hasUser": false,
          "canAddUser": false,
          "cannotAddUserReason": null
        },
        {
          "id": "recent",
          "type": "recent",
          "name": "Recent (last 24 hours)",
          "hasUser": false,
          "canAddUser": false,
          "cannotAddUserReason": "SYSTEM_LIST"
        },
        {
          "id": "fans",
          "type": "fans",
          "name": "Fans",
          "hasUser": true,
          "canAddUser": false,
          "cannotAddUserReason": "ALREADY_EXISTS"
        },
        {
          "id": "rebill_off",
          "type": "rebill_off",
          "name": "Renew Off",
          "hasUser": true,
          "canAddUser": false,
          "cannotAddUserReason": "ALREADY_EXISTS"
        },
        {
          "id": "following",
          "type": "following",
          "name": "Following",
          "hasUser": false,
          "canAddUser": false,
          "cannotAddUserReason": "SYSTEM_LIST"
        }
      ],
      "showMediaCount": true,
      "lastSeen": "2025-07-02T00:00:00+00:00",
      "canReport": false
    }
  }
}
```

### 🎉 New Subscription

A new fan has subscribed.

```json title="Example data"
{
  "event": "subscriptions.new",
  "account_id": "acct_123",
  "payload": {
    "id": "123",
    "type": "subscribed",
    "createdAt": "2025-05-05T21:27:00+00:00",
    "text": "subscribed to your profile!",
    "replacePairs": {
      "{SUBSCRIBER_LINK}": "<a href='https://onlyfans.com/username'>Name</a>",
      "{PRICE}": "free"
    },
    "subType": "new_subscriber",
    "user_id": "123",
    "isRead": false,
    "canGoToProfile": true,
    "user": {
      "avatar": "https://example.com",
      "avatarThumbs": {
        "c50": "https://example.com",
        "c144": "https://example.com"
      },
      "header": "https://example.com",
      "headerSize": {
        "width": 767,
        "height": 1152
      },
      "headerThumbs": {
        "w480": "https://example.com",
        "w760": "https://example.com"
      },
      "id": 123,
      "name": "Name",
      "username": "username",
      "canLookStory": false,
      "canCommentStory": false,
      "hasNotViewedStory": false,
      "isVerified": true,
      "canPayInternal": false,
      "hasScheduledStream": false,
      "hasStream": false,
      "hasStories": false,
      "tipsEnabled": true,
      "tipsTextEnabled": true,
      "tipsMin": 5,
      "tipsMinInternal": 1,
      "tipsMax": 200,
      "canEarn": true,
      "canAddSubscriber": false,
      "subscribePrice": 0,
      "subscribedBy": false,
      "subscribedOn": false,
      "canReceiveChatMessage": false,
      "hideChat": false,
      "lastSeen": "2025-05-05T21:26:04+00:00",
      "isPerformer": true,
      "isRealPerformer": true,
      "view": "mn",
      "canReport": true,
      "subscribedByData": null,
      "subscribedOnData": null,
      "isBlocked": false
    }
  }
}
```

### 🎉 Subscription renewed

A fan has renewed their subscription.

```json title="Example data"
{
  "event": "subscriptions.renewed",
  "account_id": "acct_123",
  "payload": {
    "id": "123",
    "type": "subscribed",
    "createdAt": "2025-05-05T21:27:00+00:00",
    "text": "Good news! <a href='https://onlyfans.com/u34547118'>u34547118</a> has Just restarted their monthly subscription to your OnlyFans profile!",
    "replacePairs": {
      "{SUBSCRIBER_LINK}": "<a href='https://onlyfans.com/u34547118'>u34547118</a>",
      "{PRICE}": "$4.00"
    },
    "subType": "returning_subscriber",
    "user_id": "34547118",
    "isRead": false,
    "canGoToProfile": true,
    "user": {
      "avatar": "https://example.com",
      "avatarThumbs": {
        "c50": "https://example.com",
        "c144": "https://example.com"
      },
      "header": "https://example.com",
      "headerSize": {
        "width": 767,
        "height": 1152
      },
      "headerThumbs": {
        "w480": "https://example.com",
        "w760": "https://example.com"
      },
      "id": 34547118,
      "name": "Name",
      "username": "username",
      "canLookStory": false,
      "canCommentStory": false,
      "hasNotViewedStory": false,
      "isVerified": true,
      "canPayInternal": false,
      "hasScheduledStream": false,
      "hasStream": false,
      "hasStories": false,
      "tipsEnabled": true,
      "tipsTextEnabled": true,
      "tipsMin": 5,
      "tipsMinInternal": 1,
      "tipsMax": 200,
      "canEarn": true,
      "canAddSubscriber": false,
      "subscribePrice": 0,
      "subscribedBy": false,
      "subscribedOn": false,
      "canReceiveChatMessage": false,
      "hideChat": false,
      "lastSeen": "2025-05-05T21:26:04+00:00",
      "isPerformer": true,
      "isRealPerformer": true,
      "view": "mn",
      "canReport": true,
      "subscribedByData": null,
      "subscribedOnData": null,
      "isBlocked": false
    }
  }
}
```

### ❤️ Post Liked

A fan has liked one of your posts.

```json title="Example data"
{
  "event": "posts.liked",
  "account_id": "acct_123",
  "payload": {
    "id": "123",
    "type": "favorited",
    "createdAt": "2025-05-05T22:22:00+00:00",
    "text": "liked your <a href='https://onlyfans.com/123/username'>post</a>",
    "replacePairs": {
      "{POST_LINK}": "<a href='https://onlyfans.com/123/username'>post</a>"
    },
    "subType": "new_favorite",
    "user_id": "123",
    "isRead": false,
    "canGoToProfile": true,
    "user": {
      "avatar": null,
      "avatarThumbs": null,
      "header": null,
      "headerSize": null,
      "headerThumbs": null,
      "id": 123,
      "name": "Name",
      "username": "username",
      "canLookStory": false,
      "canCommentStory": false,
      "hasNotViewedStory": false,
      "isVerified": false,
      "canPayInternal": false,
      "hasScheduledStream": false,
      "hasStream": false,
      "hasStories": false,
      "tipsEnabled": false,
      "tipsTextEnabled": true,
      "tipsMin": 5,
      "tipsMinInternal": 1,
      "tipsMax": 200,
      "canEarn": false,
      "canAddSubscriber": false,
      "subscribePrice": 0,
      "subscribedBy": false,
      "subscribedOn": false,
      "canReceiveChatMessage": false,
      "hideChat": false,
      "lastSeen": null,
      "isPerformer": false,
      "isRealPerformer": false,
      "view": "mn",
      "canReport": true,
      "subscribedByData": null,
      "subscribedOnData": null,
      "isBlocked": false
    }
  }
}
```

### 💬 User is Typing

A fan is typing a message.

```json title="Example data"
{
  "event": "users.typing",
  "account_id": "acct_123",
  "payload": {
    "id": 123
  }
}
```

### ℹ️ New Account Connected

A new OnlyFans account was connected.

<Callout>
  Please note that `payload.client_reference_id` can be null - it's only
  included if you provided us with `client_reference_id` while [Creating Client
  Session](/api-reference/client-sessions/create-client-session)
</Callout>

```json title="Example data"
{
  "event": "accounts.connected",
  "account_id": "acct_123",
  "payload": {
    "client_reference_id": "my_crm_model_12345", // Optional - Value you provided while creating Client Session - otherwise null
    "state": "authenticated",
    "progress": "started",
    "latestAuthAttempt": {
      "started_at": "2025-05-13T20:26:56.000000Z",
      "completed_at": null,
      "success": false,
      "error_message": null,
      "needs_otp": false,
      "needs_face_otp": false,
      "otp_phone_ending": null
    }
  }
}
```

### ℹ️ Account Connection Failed

An OnlyFans account's connection has expired, and we couldn't automatically re-connect it using our system.

```json title="Example data"
{
  "event": "accounts.authentication_failed",
  "account_id": "acct_123",
  "payload": {
    "state": "authenticated",
    "progress": "started",
    "latestAuthAttempt": {
      "started_at": "2025-05-13T20:26:56.000000Z",
      "completed_at": null,
      "success": false,
      "error_message": null,
      "needs_otp": false,
      "needs_face_otp": false,
      "otp_phone_ending": null
    }
  }
}
```

### ℹ️ Account Session Expired

An OnlyFans account's connection has expired, but we're automatically re-connecting it using our system — you don't need to do anything.

```json title="Example data"
{
  "event": "accounts.session_expired",
  "account_id": "acct_123",
  "payload": {
    "state": "authenticated",
    "progress": "started",
    "latestAuthAttempt": {
      "started_at": "2025-05-13T20:26:56.000000Z",
      "completed_at": null,
      "success": false,
      "error_message": null,
      "needs_otp": false,
      "needs_face_otp": false,
      "otp_phone_ending": null
    }
  }
}
```

### ℹ️ Face OTP Required For Account

Face verification is required to connect one of your OnlyFans accounts

```json title="Example data"
{
  "event": "accounts.face_otp_required",
  "account_id": "acct_123",
  "payload": {
    "state": "authenticated",
    "progress": "started",
    "face_otp_verification_url": "https://id.onlyfans.com/s?123",
    "latestAuthAttempt": {
      "started_at": "2025-05-13T20:26:56.000000Z",
      "completed_at": null,
      "success": false,
      "error_message": null,
      "needs_otp": false,
      "needs_face_otp": false,
      "otp_phone_ending": null
    }
  }
}
```

### ℹ️ OTP Code Required For Account

A two-factor authentication code is required to connect one of your OnlyFans accounts.

```json title="Example data"
{
  "event": "accounts.otp_code_required",
  "account_id": "acct_123",
  "payload": {
    "state": "authenticated",
    "progress": "started",
    "latestAuthAttempt": {
      "started_at": "2025-05-13T20:26:56.000000Z",
      "completed_at": null,
      "success": false,
      "error_message": null,
      "needs_otp": false,
      "needs_face_otp": false,
      "otp_phone_ending": null
    }
  }
}
```

## Actions

Actions are simple modules that return a single result.

### 🕘 Get Profile View Duration Totals

Get the view duration stats for guests, users, and combined for the specified timeframe.

```json title="Example data"
{
  "total": 123,
  "guests": "123",
  "users": "123",
  "subscribers": 123
}
```

### 📈 Get Profile Visitor Totals

Get the profile visit stats for guests, users, and combined for the specified timeframe.

```json title="Example data"
{
  "total": 123,
  "guests": "123",
  "users": "123",
  "subscribers": 123
}
```

### 💰 Get Total Earnings

Get the total earnings for a given period.

```json title="Example data"
{
  "delta": 1.2,
  "gross": 123.45,
  "total": 123.45
}
```

## Searches

### 📈 \[Payouts] List Earning Statistics

List all earning statistics for the account.

```json title="Example data"
{
  "months": {
    "123": {
      "tips": [
        {
          "time": 123,
          "net": 123,
          "gross": 123
        }
      ],
      "total_net": 123,
      "total_gross": 123,
      "subscribes": [
        {
          "time": 123,
          "net": 123,
          "gross": 123
        }
      ],
      "chat_messages": [
        {
          "time": 123,
          "net": 123,
          "gross": 123
        }
      ],
      "post": [
        {
          "time": 123,
          "net": 123,
          "gross": 123
        }
      ]
    }
  },
  "total": {
    "tips": {
      "total_net": 123,
      "total_gross": 123
    },
    "all": {
      "total_net": 123,
      "total_gross": 123
    },
    "subscribes": {
      "total_net": 123,
      "total_gross": 123
    },
    "chat_messages": {
      "total_net": 123,
      "total_gross": 123
    },
    "post": {
      "total_net": 123,
      "total_gross": 123
    }
  }
}
```

### 🌍 Get Profile Visitors (Top Countries)

Get the top countries of profile visitors for a specified timeframe

```json title="Example data"
{
  "rank": 1,
  "countryName": "United States",
  "countryCode": "US",
  "viewsCount": {
    "total": 123,
    "guests": 123,
    "users": 123,
    "subscribers": 123
  }
}
```

### 📋 List Accounts

List all connected OnlyFans accounts.

```json title="Example data"
{
  "id": "acct_123",
  "is_authenticated": true,
  "authentication_progress": "signed_in",
  "display_name": "display name",
  "onlyfans_user_data": {
    "id": 123,
    "ip": "127.0.0.1",
    "csrf": "csrf",
    "name": "Name",
    "view": "f",
    "about": "<p>About</p>",
    "email": "user@example.com",
    "wsUrl": "wss://ws2.onlyfans.com/ws3/01",
    "avatar": "https://public.onlyfans.com/.../avatar.jpg",
    "header": "https://public.onlyfans.com/.../header_image.jpg",
    "isAuth": true,
    "ivFlow": "default",
    "upload": {
      "geoUploadArgs": {
        "preset": "of_beta",
        "isDelay": true,
        "additional": {
          "user": "123"
        },
        "needThumbs": true,
        "preset_png": "of_png",
        "protected_preset": "of_drm"
      }
    },
    "canChat": true,
    "canEarn": true,
    "hasTags": false,
    "tipsMax": 200,
    "tipsMin": 5,
    "website": null,
    "advBlock": ["banners"],
    "hasLinks": false,
    "ivStatus": "approved",
    "joinDate": "2025-01-01T00:00:00+00:00",
    "lastSeen": "2025-01-21T00:00:00+00:00",
    "location": null,
    "paidFeed": false,
    "username": "username",
    "wishlist": null,
    "hasLabels": true,
    "hasStream": false,
    "hasStripe": false,
    "ivCountry": "US",
    "canAddCard": true,
    "canPinPost": true,
    "creditsMax": 200,
    "creditsMin": 10,
    "hasFriends": false,
    "hasStories": false,
    "headerSize": {
      "width": 4032,
      "height": 3024
    },
    "isVerified": true,
    "payoutType": "bank_ebics_sepa",
    "postsCount": 1,
    "unreadTips": 0,
    "audiosCount": 0,
    "canAddStory": true,
    "hasNewHints": true,
    "hasScenario": false,
    "isPerformer": true,
    "mediasCount": 1,
    "photosCount": 1,
    "tipsEnabled": false,
    "videosCount": 0,
    "wsAuthToken": "wsAuthToken",
    "avatarThumbs": {
      "c50": "https://thumbs.onlyfans.com/.../avatar.jpg",
      "c144": "https://thumbs.onlyfans.com/.../avatar.jpg"
    },
    "canLookStory": true,
    "canStreaming": false,
    "canTrialSend": false,
    "hasNewAlerts": false,
    "headerThumbs": {
      "w480": "https://thumbs.onlyfans.com/.../header_image.jpg",
      "w760": "https://thumbs.onlyfans.com/.../header_image.jpg"
    },
    "isOtpEnabled": true,
    "ivFailReason": null,
    "newTagsCount": 0,
    "postMaxPrice": 100,
    "postMinPrice": 3,
    "trialMaxDays": 7,
    "creditBalance": 0,
    "faceIdRegular": [],
    "isAgeVerified": false,
    "isAllowTweets": false,
    "isMakePayment": false,
    "isStripeExist": false,
    "isVatRequired": false,
    "needIVApprove": false,
    "vatNumberName": "VAT",
    "watermarkText": "OnlyFans.com/username",
    "canCreateLists": true,
    "canCreateTrial": true,
    "canPayInternal": true,
    "favoritedCount": 0,
    "favoritesCount": 0,
    "hasPinnedPosts": false,
    "isAdultContent": false,
    "isEmailChecked": true,
    "isWantComments": true,
    "showMediaCount": true,
    "subscribePrice": 4.99,
    "canCommentStory": true,
    "countPinnedChat": 0,
    "isEmailRequired": false,
    "isPaywallPassed": true,
    "isRealPerformer": true,
    "isVisibleOnline": true,
    "messageMaxPrice": 100,
    "messageMinPrice": 3,
    "showPostsInFeed": true,
    "subscribesCount": 123,
    "tipsMinInternal": 1,
    "tipsTextEnabled": true,
    "twitterUsername": "TwitterUsername",
    "canAddSubscriber": false,
    "canSendChatToAll": true,
    "isCountryWithVat": false,
    "isCreditsEnabled": true,
    "isVerifiedReason": false,
    "pinnedPostsCount": 0,
    "subscribedByData": null,
    "subscribedOnData": null,
    "subscribersCount": 123,
    "chatMessagesCount": 123,
    "countPriorityChat": 123,
    "hasNotViewedStory": false,
    "hasPurchasedPosts": false,
    "hasWatermarkPhoto": true,
    "hasWatermarkVideo": true,
    "isDeleteInitiated": false,
    "isReferrerAllowed": true,
    "isSpringConnected": false,
    "subscribeMaxPrice": 50,
    "subscribeMinPrice": 4.99,
    "watermarkPosition": "bottom_right",
    "archivedPostsCount": 0,
    "canCreatePromotion": true,
    "canMakeExpirePosts": true,
    "hasScheduledStream": false,
    "isSpotifyConnected": false,
    "isTwitterConnected": false,
    "notificationsCount": 0,
    "walletFirstRebills": false,
    "canConnectOfAccount": true,
    "connectedOfAccounts": [],
    "hasInternalPayments": false,
    "hasNewTicketReplies": {
      "open": false,
      "closed": false,
      "solved": false
    },
    "isNeedConfirmPayout": false,
    "isRealCardConnected": true,
    "ivHideForPerformers": false,
    "maxPinnedPostsCount": 5,
    "subscriptionBundles": [],
    "trialMaxExpiresDays": 30,
    "canCreateFundRaising": false,
    "isPrivateRestriction": false,
    "isWalletAutorecharge": false,
    "maxFundRaisingTarget": 10000,
    "minFundRaisingTarget": 10,
    "showSubscribersCount": false,
    "canChangeContentPrice": true,
    "canReceiveChatMessage": false,
    "walletAutorechargeMin": 0,
    "canReceiveManualPayout": true,
    "canReceiveStripePayout": false,
    "firstPublishedPostDate": "2025-01-01T00:00:00+00:00",
    "hasSystemNotifications": false,
    "isCountryVatRefundable": false,
    "isLegalApprovedAllowed": true,
    "isPaymentCardConnected": true,
    "ageVerificationRequired": false,
    "payoutLegalApproveState": "approved",
    "walletAutorechargeAmount": 0,
    "canAlternativeWalletTopUp": false,
    "enabledImageEditorForChat": true,
    "isCountryVatNumberCollect": false,
    "isScheduledStreamsAllowed": false,
    "privateArchivedPostsCount": 0,
    "isMarkdownDisabledForAbout": true,
    "avatarHeaderConverterUpload": true,
    "hasNewChangedPriceSubscriptions": true
  }
}
```

### 💰 List Earnings (monetary values)

Get the earnings in monetary values for a given period. E.g. `123.45`

```json title="Example data"
{
  "date": "2025-01-01T00:00:00+00:00",
  "count": 123.45
}
```

### 💰 List Earnings (transaction count)

Get the transaction counts for a given period. E.g. `123`

```json title="Example data"
{
  "date": "2025-01-01T00:00:00+00:00",
  "count": 123
}
```

### 🔗 List Tracking Links

List all tracking links & their revenue data for the account.

```json title="Example data"
{
  "id": 123,
  "campaignCode": 1,
  "campaignName": "campaign-name",
  "campaignUrl": "https://onlyfans.com/username/c1",
  "subscribersCount": 123,
  "clicksCount": 123,
  "createdAt": "2025-05-23T16:19:38+00:00",
  "endDate": null,
  "revenue": {
    "total": 0,
    "revenuePerSubscriber": 0,
    "revenuePerClick": 0,
    "calculatedAt": "2025-05-23T16:45:36.000000Z",
    "isLoading": false
  },
  "links": {
    "related": {
      "subscribers": "https://app.onlyfansapi.com/api/acct_123/tracking-links/123/subscribers"
    }
  }
}
```

### 🔗 List Tracking Link Subscribers

Get list of subscribers who joined through a Tracking Link.

```json title="Example data"
{
  "view": "s",
  "avatar": null,
  "avatarThumbs": null,
  "header": null,
  "headerSize": null,
  "headerThumbs": null,
  "id": 123,
  "name": "name",
  "username": "username",
  "canLookStory": false,
  "canCommentStory": false,
  "hasNotViewedStory": false,
  "isVerified": false,
  "canPayInternal": false,
  "hasScheduledStream": false,
  "hasStream": false,
  "hasStories": false,
  "tipsEnabled": false,
  "tipsTextEnabled": true,
  "tipsMin": 5,
  "tipsMinInternal": 1,
  "tipsMax": 200,
  "canEarn": false,
  "canAddSubscriber": false,
  "subscribePrice": 0,
  "displayName": "",
  "notice": "",
  "isRestricted": false,
  "canRestrict": true,
  "subscribedBy": true,
  "subscribedByExpire": false,
  "subscribedByExpireDate": "2025-01-01T00:00:00+00:00",
  "subscribedByAutoprolong": true,
  "subscribedIsExpiredNow": false,
  "currentSubscribePrice": 0,
  "subscribedOn": true,
  "subscribedOnExpiredNow": false,
  "subscribedOnDuration": "1 year",
  "showMediaCount": true,
  "lastSeen": null,
  "canReport": true
}
```

### 💳 List Transactions

Get a paginated list of transactions for an Account. Newest transactions are first.

```json title="Example data"
{
  "amount": 9.99,
  "vatAmount": 0.5,
  "taxAmount": 0,
  "net": 7.99,
  "fee": 2,
  "createdAt": "2025-05-26T00:00:00+00:00",
  "currency": "USD",
  "description": "Payment for message from <a href=\"https://onlyfans.com/username\">User</a>",
  "status": "loading",
  "user": {
    "view": "t",
    "id": 123,
    "name": "Name",
    "username": "username",
    "isVerified": false,
    "avatar": null,
    "avatarThumbs": null
  },
  "payoutPendingDays": 7,
  "id": "exampleId"
}
```

### 🆓 List Trial Links

List all trial links & their revenue data for the account.

```json title="Example data"
{
  "id": 123,
  "trialLinkName": "My trial link",
  "url": "https://onlyfans.com/username/trial/abc123",
  "subscribeDays": 7,
  "subscribeCounts": 123,
  "claimCounts": 123,
  "expiredAt": null,
  "createdAt": "2025-01-01T00:00:00+00:00",
  "isFinished": false
}
```

## Universal

### Make a custom API call

Call any OnlyFans API endpoint from Make.com.

# Make.com & OnlyFans - Quickstart (/integrations/make)

import { DownloadIcon } from "lucide-react";
import { Step, Steps } from "fumadocs-ui/components/steps";
import { Card } from "fumadocs-ui/components/card";

## Prerequisites

To get started, you must have:

* An OnlyFans API account with a creator account connected
* A [Make.com](https://www.make.com/en/register?pc=onlyfans) account

## Getting started

<Steps>
  <Step>
    Log in to your Make.com account.
  </Step>

  <Step>
    Install our Make.com integration:

    <Card icon={<DownloadIcon className="text-fd-primary" />} href="https://www.make.com/en/hq/app-invitation/ee8eed5fafe0c65c4989c5b7112b741d" title="Install our Make.com app" className="w-fit">
      It only takes a few seconds.
    </Card>
  </Step>
</Steps>

## Connecting your OnlyFans API account to Make.com

<Steps>
  <Step>
    ### Go to a Make scenario, or create a new scenario \[!toc]

    Go to the Scenarios page in Make.com, click on the relevant scenario, or click on "Create a new scenario".
  </Step>

  <Step title="">
    ### Add the OnlyFans API app \[!toc]

    Click on the "+" button to add an app, and search for "OnlyFans API".
  </Step>

  <Step title="">
    ### Select or search for a module \[!toc]

        <img alt="" src={__img0} placeholder="blur" />
  </Step>

  <Step title="">
    ### Add a new API connection \[!toc]

        <img alt="" src={__img1} placeholder="blur" />
  </Step>

  <Step title="">
    ### Create a new API key from the OnlyFans API Console \[!toc]

    <Steps>
      <Step title="">
        #### Go to the OnlyFans API console -> API Keys \[!toc]

                <img alt="" src={__img2} placeholder="blur" />
      </Step>

      <Step title="">
        #### Create a new API key from the OnlyFans API Console \[!toc]

                <img alt="" src={__img3} placeholder="blur" />
      </Step>

      <Step title="">
        #### Give it a name, and press "Add" \[!toc]

                <img alt="" src={__img4} placeholder="blur" />
      </Step>

      <Step title="">
        #### Copy the API key to your clipboard \[!toc]

                <img alt="" src={__img5} placeholder="blur" />
      </Step>
    </Steps>
  </Step>

  <Step title="">
    ### Save the new API key in Make.com \[!toc]

    Give the connection a helpful name, paste the API key, and click "Save".
        <img alt="" src={__img6} placeholder="blur" />
  </Step>
</Steps>

<Callout type="success" title="That's it!">
  You're now ready to use the OnlyFans API app in your Make.com scenario.
</Callout>

## Tutorial Video

<iframe className="aspect-video w-full" src="https://www.youtube.com/embed/6C8DzQSDorI" title="Automate Anything on OnlyFans with NO CODE! 🚀 | OnlyFansAPI Tutorial" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen />

# Ready-made scenarios (/integrations/make/ready-made-scenarios)

import { Step, Steps } from 'fumadocs-ui/components/steps';

### Available blueprints

<Cards>
  <Card href="https://gist.githubusercontent.com/iDiegoNL/ae3e8b2d9dfe1ce337cef5344c2ad6bb/raw/84f22ce4cc2ff9999597d8f70a8d8dce94d8ea4b/ofapi-accounts.blueprint.json">
    ### Account synchronization \[!toc]

    <img alt="Account Sync scenario" src="/images/make-com/account-sync-scenario.png" className="rounded" />

    This scenario will synchronize your OnlyFans accounts with Airtable, and update the data once a day.

    <span className="text-fd-primary">
      **Download scenario blueprint ›**
    </span>
  </Card>

  <Card href="https://gist.githubusercontent.com/iDiegoNL/82620611b39bb5c55dcd4f95f6a7d7a0/raw/ab09d1e864730bdc86420f3cf8c9c8c4478d4c3c/ofapi-hourly-revenue-data.json">
    ### Hourly account revenue data \[!toc]

    <img alt="Account Sync scenario" src="/images/make-com/earning-statistics-sync-scenario.png" className="rounded" />

    This scenario will synchronize your OnlyFans account revenue data with Airtable. Every account will have one record for each day, which updates hourly.

    <span className="text-fd-primary">
      **Download scenario blueprint ›**
    </span>
  </Card>
</Cards>

### How to use the scenario blueprints

<Callout title="We recommend creating a new scenario and importing the blueprint there.">
  If you import a blueprint while editing another scenario that hasn't been saved, all the changes in that scenario will be lost.
</Callout>

To import a blueprint:

<Steps>
  <Step>
    #### On the Scenario Builder toolbar, click the three dots > Import blueprint. \[!toc]

        <img alt="" src={__img0} placeholder="blur" />
  </Step>

  <Step>
    #### Click Choose File, select the blueprint file in .json format, and click Save. \[!toc]

        <img alt="" src={__img1} placeholder="blur" />
  </Step>
</Steps>

<Callout type="success">
  The imported scenario appears in the Scenario Builder. You can now configure your own account connections, make any necessary edits to the scenario, schedule it, and click the Save icon.
</Callout>

# n8n & OnlyFans - Available modules (/integrations/n8n/available-modules)

import {ZapIcon} from "lucide-react";

<Callout title="This integration supports every OnlyFans API endpoint!" type="success" icon={<ZapIcon size={18} className="text-(--callout-color)"/>}>
  Our n8n integration is our most actively maintained integration, and it supports every single endpoint in our API.
</Callout>

<Callout title="Available in official n8n node library or self-hosted instances" type="success">
  Currently, our n8n integration is available in the official n8n nodes library or as a self-hosted instance.
</Callout>

<div className="pt-10">
  import { SiOnlyfans } from "@icons-pack/react-simple-icons";
  import { FanslyIcon } from "@/components/fansly-icon";

  ## Pick your platform

  We currently offer two API surfaces. Choose the one you're building against to explore its endpoints.

    <Cards>
      <Card icon={<SiOnlyfans />} href="/api-reference/overview" title="OnlyFans API">
        Our most popular API with 350+ endpoints covering messaging, fans, media, payouts, posts, and more.
      </Card>

      <Card icon={<FanslyIcon />} href="/api-reference/fansly" title="Fansly API">
        Our brand-new Fansly API, currently in closed beta with a public launch coming soon.
      </Card>
    </Cards>
</div>

# n8n & OnlyFans - Quickstart (/integrations/n8n)

import {
  SiDigitalocean,
  SiHostinger,
  SiN8n,
} from "@icons-pack/react-simple-icons";
import { BoxIcon, ServerIcon, TerminalIcon } from "lucide-react";
import { Step, Steps } from "fumadocs-ui/components/steps";
import { Card, Cards } from "fumadocs-ui/components/card";
import { Accordion, Accordions } from "fumadocs-ui/components/accordion";

import {ZapIcon} from "lucide-react";

<Callout title="This integration supports every OnlyFans API endpoint!" type="success" icon={<ZapIcon size={18} className="text-(--callout-color)"/>}>
  Our n8n integration is our most actively maintained integration, and it supports every single endpoint in our API.
</Callout>

<Callout title="Available in official n8n node library or self-hosted instances" type="success">
  Currently, our n8n integration is available in the official n8n nodes library or as a self-hosted instance.
</Callout>

## Prerequisites

To get started, you must have:

<Cards>
  <Card icon={<TerminalIcon className="text-fd-primary" />} href="https://app.onlyfansapi.com" title="An OnlyFans API account">
    If you don't have one yet, registering takes just a few seconds.

    <span className="flex flex-row items-center gap-1 w-fit">
      » Create a free account
    </span>
  </Card>

  <Card icon={<SiN8n color="default" />} title="A n8n instance">
    You can either use n8n's native infrastructure, or a one-click provider. Some popular options are:

    <a className="flex flex-row items-center gap-1 w-fit" href="https://n8n.partnerlinks.io/onlyfans" target="_blank">
      <SiN8n size={16} color="default" />

      <span>
        n8n Cloud (native)
      </span>
    </a>

    <a className="flex flex-row items-center gap-1 mt-2 w-fit" href="https://www.hostinger.com/self-hosted-n8n?REFERRALCODE=onlyfans" target="_blank">
      <SiHostinger size={16} color="default" />

      <span>
        Hostinger (20% off)
      </span>
    </a>

    <a className="flex flex-row items-center gap-1 mt-2 w-fit" href="https://marketplace.digitalocean.com/apps/n8n?refcode=4192ba3a094a" target="_blank">
      <SiDigitalocean size={16} color="default" />

      <span>
        DigitalOcean (Get $200 in credit)
      </span>
    </a>

    <a className="flex flex-row items-center gap-1 mt-2 w-fit" href="https://docs.n8n.io/hosting" target="_blank">
      <ServerIcon size={16} className="text-fd-primary" />

      <span>
        Self-hosted
      </span>
    </a>
  </Card>
</Cards>

## Installing the OnlyFans API node

<Callout type="info" title="Limited to n8n instance owners">
  Only the n8n instance owner can install and manage verified community nodes.
  The instance owner is the person who sets up and manages user management.
  All members of an n8n instance can use already installed community nodes in their workflows.
</Callout>

To install the OnlyFans API node in your n8n instance:

<Steps>
  <Step>
    Log in to your n8n instance.
  </Step>

  <Step>
    Create a new workflow by clicking on **"Create workflow"** in the top right corner.
  </Step>

  <Step>
    Go to the Canvas and open the nodes panel (either by selecting '+' or pressing `Tab`).
        <img alt="Open nodes panel" src={__img0} placeholder="blur" />
  </Step>

  <Step>
    Search for "OnlyFans API" in the nodes panel, and select it. This takes you to a detailed view of the OnlyFans API node, showing all the supported actions.
        <img alt="Select OnlyFans API node" src={__img1} placeholder="blur" />
  </Step>

  <Step>
    Next to our logo, click on the **"Install node"** button.
    This will install the node for your instance and enable all members to use it in their workflows.
        <img alt="Install OnlyFans API node" src={__img2} placeholder="blur" />
  </Step>

  <Step>
    That's it! You can now add the node to your workflows.
  </Step>
</Steps>

## Updating the OnlyFans API node

We frequently release updates to our n8n node, adding new features and fixing bugs. To update to the latest version, follow the instructions below:

<Accordions type="single" orientation="vertical">
  <Accordion title="Using the n8n interface">
    <Steps>
      <Step>
        Access the **"Community nodes"** page through the n8n settings
      </Step>

      <Step>
        Find the OnlyFans API node in the list of installed nodes, and click on the **"Update"** button next to it
      </Step>

      <Step>
        Follow the prompts to complete the update process.
      </Step>
    </Steps>
  </Accordion>

  <Accordion title="Manually from the command line">
    <Steps>
      <Step>
        Access your Docker shell:

        ```bash
        docker exec -it n8n sh
        ```
      </Step>

      <Step>
        Update our node through your package manager:

        ```bash
        npm update @onlyfansapi/n8n-nodes-onlyfansapi
        ```
      </Step>
    </Steps>
  </Accordion>
</Accordions>

## Connecting your OnlyFans API account to n8n

<Steps>
  <Step>
    Head to your n8n instance's homepage, and click on **"Create Credential"**
    in the **"Create Workflow"** dropdown.     <img
          alt="Add
    credentials"
          src={__img3}
          placeholder="blur"
        />
  </Step>

  <Step>
    Select **"OnlyFans API"** from the list of available credential types, and
    click **"Continue"**.     <img
          alt="Add credential
    modal"
          src={__img4}
          placeholder="blur"
        />
  </Step>

  <Step>
    ### Create a new API key from the OnlyFans API Console \[!toc]

    <Steps>
      <Step>
        #### Go to the OnlyFans API console -> API Keys \[!toc]

                <img alt="" src={__img5} placeholder="blur" />
      </Step>

      <Step>
        #### Create a new API key from the OnlyFans API Console \[!toc]

                <img alt="" src={__img6} placeholder="blur" />
      </Step>

      <Step>
        #### Give it a name, and press "Add" \[!toc]

                <img alt="" src={__img7} placeholder="blur" />
      </Step>

      <Step>
        #### Copy the API key to your clipboard \[!toc]

                <img alt="" src={__img8} placeholder="blur" />
      </Step>
    </Steps>
  </Step>

  <Step>
    Paste the API key into the **"API Key"** field, and click **"Save"**.
        <img alt="Enter credentials" src={__img9} placeholder="blur" />
  </Step>
</Steps>

# Notes (/integrations/n8n/main-callouts)

import {ZapIcon} from "lucide-react";

<Callout title="This integration supports every OnlyFans API endpoint!" type="success" icon={<ZapIcon size={18} className="text-(--callout-color)"/>}>
  Our n8n integration is our most actively maintained integration, and it supports every single endpoint in our API.
</Callout>

<Callout title="Available in official n8n node library or self-hosted instances" type="success">
  Currently, our n8n integration is available in the official n8n nodes library or as a self-hosted instance.
</Callout>

# Available modules (/integrations/zapier/available-modules)

<Callout title="Looking for a specific module?">
  Please reach out to us, we can add it!
</Callout>

## Instant Triggers

An Instant Trigger (also known as a "webhook"), is a module that is executed immediately when an event occurs.

### 🤑 Chat Message PPV Purchased

A PPV (pay-per-view) message that you sent has been purchased by a fan

```json title="Example data"
{
    "event": "messages.ppv.unlocked",
    "account_id": "acct_123",
    "payload": {
        "id": "123",
        "type": "paided_message",
        "createdAt": "2025-05-05T22:18:00+00:00",
        "text": "has purchased your <a href='https://onlyfans.com/my/chats/chat/123?firstId=123'>message</a> for $5.00!",
        "replacePairs": {
            "{NAME}": "Name",
            "{MESSAGE_LINK}": "<a href='https://onlyfans.com/my/chats/chat/123?firstId=123'>message</a>",
            "{AMOUNT}": "$5.00"
        },
        "subType": "subscriber_pay_for_chat_message",
        "user_id": "123",
        "isRead": false,
        "canGoToProfile": true,
        "user": {
            "avatar": null,
            "avatarThumbs": null,
            "header": null,
            "headerSize": null,
            "headerThumbs": null,
            "id": 123,
            "name": "Name",
            "username": "username",
            "canLookStory": false,
            "canCommentStory": false,
            "hasNotViewedStory": false,
            "isVerified": false,
            "canPayInternal": false,
            "hasScheduledStream": false,
            "hasStream": false,
            "hasStories": false,
            "tipsEnabled": false,
            "tipsTextEnabled": true,
            "tipsMin": 5,
            "tipsMinInternal": 1,
            "tipsMax": 200,
            "canEarn": false,
            "canAddSubscriber": false,
            "subscribePrice": 0,
            "subscribedBy": false,
            "subscribedOn": false,
            "canReceiveChatMessage": false,
            "hideChat": false,
            "lastSeen": "2025-05-05T22:17:29+00:00",
            "isPerformer": false,
            "isRealPerformer": false,
            "view": "mn",
            "canReport": true,
            "subscribedByData": null,
            "subscribedOnData": null,
            "isBlocked": false
        }
    }
}
```

### 📥 Chat Message Received

A new chat message has been received.

```json title="Example data"
{
    "event": "messages.received",
    "account_id": "acct_abc123",
    "payload": {
        "responseType": "message",
        "text": "<p>Text</p>",
        "giphyId": null,
        "lockedText": false,
        "isFree": true,
        "price": 0,
        "isMediaReady": true,
        "mediaCount": 0,
        "media": [ ],
        "previews": [ ],
        "isTip": false,
        "isReportedByMe": false,
        "isCouplePeopleMedia": false,
        "queueId": 123,
        "isMarkdownDisabled": true,
        "fromUser": {
            "view": "s",
            "avatar": "https://public.onlyfans.com/files/.../avatar.jpg",
            "avatarThumbs": {
                "c50": "https://thumbs.onlyfans.com/public/files/thumbs/c50/.../avatar.jpg",
                "c144": "https://thumbs.onlyfans.com/public/files/thumbs/c144/.../avatar.jpg"
            },
            "header": "https://public.onlyfans.com/files/f/fn/fni/.../header.jpg",
            "headerSize": {
                "width": 4000,
                "height": 3000
            },
            "headerThumbs": {
                "w480": "https://thumbs.onlyfans.com/public/files/thumbs/w480/f/fn/fni/.../header.jpg",
                "w760": "https://thumbs.onlyfans.com/public/files/thumbs/w760/f/fn/fni/.../header.jpg"
            },
            "id": 123,
            "name": "Name",
            "username": "username",
            "canLookStory": true,
            "canCommentStory": true,
            "hasNotViewedStory": false,
            "isVerified": false,
            "canPayInternal": true,
            "hasScheduledStream": false,
            "hasStream": false,
            "hasStories": false,
            "tipsEnabled": false,
            "tipsTextEnabled": true,
            "tipsMin": 5,
            "tipsMinInternal": 1,
            "tipsMax": 200,
            "canEarn": false,
            "canAddSubscriber": false,
            "subscribePrice": 0,
            "displayName": "Name",
            "notice": "",
            "isRestricted": false,
            "canRestrict": true,
            "subscribedBy": true,
            "subscribedByExpire": false,
            "subscribedByExpireDate": "2025-01-01T01:11:11+00:00",
            "subscribedByAutoprolong": true,
            "subscribedIsExpiredNow": false,
            "currentSubscribePrice": 0,
            "subscribedOn": null,
            "subscribedOnExpiredNow": true,
            "subscribedOnDuration": "1 month",
            "listsStates": [
                {
                    "id": "friends",
                    "type": "friends",
                    "name": "Amigos",
                    "hasUser": false,
                    "canAddUser": false,
                    "cannotAddUserReason": "USER_NOT_PERFORMER"
                },
                {
                    "id": "muted",
                    "type": "muted",
                    "name": "Enmudecido",
                    "hasUser": false,
                    "canAddUser": true,
                    "cannotAddUserReason": null
                },
                {
                    "id": "tagged",
                    "type": "tagged",
                    "name": "etiquetado",
                    "hasUser": false,
                    "canAddUser": false,
                    "cannotAddUserReason": "SYSTEM_LIST"
                },
                {
                    "id": "rebill_on",
                    "type": "rebill_on",
                    "name": "Renovación de Facturación",
                    "hasUser": false,
                    "canAddUser": false,
                    "cannotAddUserReason": null
                },
                {
                    "id": "recent",
                    "type": "recent",
                    "name": "Reciente (últimas 24 horas)",
                    "hasUser": false,
                    "canAddUser": false,
                    "cannotAddUserReason": "SYSTEM_LIST"
                },
                {
                    "id": "fans",
                    "type": "fans",
                    "name": "Fans",
                    "hasUser": false,
                    "canAddUser": false,
                    "cannotAddUserReason": null
                },
                {
                    "id": "rebill_off",
                    "type": "rebill_off",
                    "name": "Apagar Facturación",
                    "hasUser": false,
                    "canAddUser": false,
                    "cannotAddUserReason": null
                },
                {
                    "id": "following",
                    "type": "following",
                    "name": "Siguiente",
                    "hasUser": true,
                    "canAddUser": false,
                    "cannotAddUserReason": "ALREADY_EXISTS"
                }
            ],
            "showMediaCount": true,
            "lastSeen": "2025-01-01T01:11:11+00:0000",
            "canReport": true
        },
        "isFromQueue": false,
        "id": 123,
        "isOpened": false,
        "isNew": true,
        "createdAt": "2025-01-01T01:11:11+00:00",
        "changedAt": "2025-01-01T01:11:11+00:00",
        "cancelSeconds": 119,
        "isLiked": false,
        "canPurchase": false,
        "canPurchaseReason": "free",
        "canReport": true,
        "canBePinned": true,
        "isPinned": false
    }
}
```

### 📤 Chat Message Sent

A new message has been sent from one of your OnlyFans accounts to a fan.

```json title="Example data"

{
    "event": "messages.sent",
    "account_id": "acct_abc123",
    "payload": {
        "responseType": "message",
        "text": "<p>Text</p>",
        "giphyId": null,
        "lockedText": true,
        "isFree": true,
        "price": 0,
        "isMediaReady": true,
        "mediaCount": 0,
        "media": [ ],
        "previews": [ ],
        "isTip": false,
        "isReportedByMe": false,
        "isCouplePeopleMedia": false,
        "queueId": 123,
        "isMarkdownDisabled": true,
        "releaseForms": [ ],
        "isFromQueue": false,
        "id": 123,
        "isOpened": false,
        "isNew": true,
        "createdAt": "2025-07-02T00:00:00+00:00",
        "changedAt": "2025-07-02T00:00:00+00:00",
        "cancelSeconds": 86400,
        "isLiked": false,
        "canPurchase": false,
        "canPurchaseReason": "free",
        "canReport": false,
        "canBePinned": true,
        "isPinned": false,
        "toUser": {
            "view": "s",
            "avatar": null,
            "avatarThumbs": null,
            "header": null,
            "headerSize": null,
            "headerThumbs": null,
            "id": 123,
            "name": "Name",
            "username": "username",
            "canLookStory": false,
            "canCommentStory": false,
            "hasNotViewedStory": false,
            "isVerified": false,
            "canPayInternal": true,
            "hasScheduledStream": false,
            "hasStream": false,
            "hasStories": false,
            "tipsEnabled": false,
            "tipsTextEnabled": true,
            "tipsMin": 5,
            "tipsMinInternal": 1,
            "tipsMax": 200,
            "canEarn": false,
            "canAddSubscriber": true,
            "subscribePrice": 0,
            "displayName": "",
            "notice": "",
            "isRestricted": false,
            "canRestrict": true,
            "subscribedBy": false,
            "subscribedByExpire": null,
            "subscribedByExpireDate": null,
            "subscribedByAutoprolong": null,
            "subscribedIsExpiredNow": null,
            "currentSubscribePrice": null,
            "subscribedOn": true,
            "subscribedOnExpiredNow": false,
            "subscribedOnDuration": "1 month",
            "listsStates": [
                {
                    "id": "friends",
                    "type": "friends",
                    "name": "Friends",
                    "hasUser": false,
                    "canAddUser": false,
                    "cannotAddUserReason": "USER_NOT_PERFORMER"
                },
                {
                    "id": "muted",
                    "type": "muted",
                    "name": "Muted",
                    "hasUser": false,
                    "canAddUser": true,
                    "cannotAddUserReason": null
                },
                {
                    "id": "tagged",
                    "type": "tagged",
                    "name": "Tagged",
                    "hasUser": false,
                    "canAddUser": false,
                    "cannotAddUserReason": "SYSTEM_LIST"
                },
                {
                    "id": "rebill_on",
                    "type": "rebill_on",
                    "name": "Renew On",
                    "hasUser": false,
                    "canAddUser": false,
                    "cannotAddUserReason": null
                },
                {
                    "id": "recent",
                    "type": "recent",
                    "name": "Recent (last 24 hours)",
                    "hasUser": false,
                    "canAddUser": false,
                    "cannotAddUserReason": "SYSTEM_LIST"
                },
                {
                    "id": "fans",
                    "type": "fans",
                    "name": "Fans",
                    "hasUser": true,
                    "canAddUser": false,
                    "cannotAddUserReason": "ALREADY_EXISTS"
                },
                {
                    "id": "rebill_off",
                    "type": "rebill_off",
                    "name": "Renew Off",
                    "hasUser": true,
                    "canAddUser": false,
                    "cannotAddUserReason": "ALREADY_EXISTS"
                },
                {
                    "id": "following",
                    "type": "following",
                    "name": "Following",
                    "hasUser": false,
                    "canAddUser": false,
                    "cannotAddUserReason": "SYSTEM_LIST"
                }
            ],
            "showMediaCount": true,
            "lastSeen": "2025-07-02T00:00:00+00:00",
            "canReport": false
        }
    }
}
```

### 🎉 New Subscriber

A new fan has subscribed.

```json title="Example data"
{
  "event": "subscriptions.new",
  "account_id": "acct_123",
  "payload": {
    "id": "123",
    "type": "subscribed",
    "createdAt": "2025-05-05T21:27:00+00:00",
    "text": "subscribed to your profile!",
    "replacePairs": {
      "{SUBSCRIBER_LINK}": "<a href='https://onlyfans.com/username'>Name</a>",
      "{PRICE}": "free"
    },
    "subType": "new_subscriber",
    "user_id": "123",
    "isRead": false,
    "canGoToProfile": true,
    "user": {
      "avatar": "https://example.com",
      "avatarThumbs": {
        "c50": "https://example.com",
        "c144": "https://example.com"
      },
      "header": "https://example.com",
      "headerSize": {
        "width": 767,
        "height": 1152
      },
      "headerThumbs": {
        "w480": "https://example.com",
        "w760": "https://example.com"
      },
      "id": 123,
      "name": "Name",
      "username": "username",
      "canLookStory": false,
      "canCommentStory": false,
      "hasNotViewedStory": false,
      "isVerified": true,
      "canPayInternal": false,
      "hasScheduledStream": false,
      "hasStream": false,
      "hasStories": false,
      "tipsEnabled": true,
      "tipsTextEnabled": true,
      "tipsMin": 5,
      "tipsMinInternal": 1,
      "tipsMax": 200,
      "canEarn": true,
      "canAddSubscriber": false,
      "subscribePrice": 0,
      "subscribedBy": false,
      "subscribedOn": false,
      "canReceiveChatMessage": false,
      "hideChat": false,
      "lastSeen": "2025-05-05T21:26:04+00:00",
      "isPerformer": true,
      "isRealPerformer": true,
      "view": "mn",
      "canReport": true,
      "subscribedByData": null,
      "subscribedOnData": null,
      "isBlocked": false
    }
  }
}
```

### 🎉 Subscription renewed

A fan has renewed their subscription.

```json title="Example data"
{
  "event": "subscriptions.renewed",
  "account_id": "acct_123",
  "payload": {
    "id": "123",
    "type": "subscribed",
    "createdAt": "2025-05-05T21:27:00+00:00",
    "text": "Good news! <a href='https://onlyfans.com/u34547118'>u34547118</a> has Just restarted their monthly subscription to your OnlyFans profile!",
    "replacePairs": {
      "{SUBSCRIBER_LINK}": "<a href='https://onlyfans.com/u34547118'>u34547118</a>",
      "{PRICE}": "$4.00"
    },
    "subType": "returning_subscriber",
    "user_id": "34547118",
    "isRead": false,
    "canGoToProfile": true,
    "user": {
      "avatar": "https://example.com",
      "avatarThumbs": {
        "c50": "https://example.com",
        "c144": "https://example.com"
      },
      "header": "https://example.com",
      "headerSize": {
        "width": 767,
        "height": 1152
      },
      "headerThumbs": {
        "w480": "https://example.com",
        "w760": "https://example.com"
      },
      "id": 34547118,
      "name": "Name",
      "username": "username",
      "canLookStory": false,
      "canCommentStory": false,
      "hasNotViewedStory": false,
      "isVerified": true,
      "canPayInternal": false,
      "hasScheduledStream": false,
      "hasStream": false,
      "hasStories": false,
      "tipsEnabled": true,
      "tipsTextEnabled": true,
      "tipsMin": 5,
      "tipsMinInternal": 1,
      "tipsMax": 200,
      "canEarn": true,
      "canAddSubscriber": false,
      "subscribePrice": 0,
      "subscribedBy": false,
      "subscribedOn": false,
      "canReceiveChatMessage": false,
      "hideChat": false,
      "lastSeen": "2025-05-05T21:26:04+00:00",
      "isPerformer": true,
      "isRealPerformer": true,
      "view": "mn",
      "canReport": true,
      "subscribedByData": null,
      "subscribedOnData": null,
      "isBlocked": false
    }
  }
}
```

### ❤️ Post Liked

A fan has liked one of your posts.

```json title="Example data"
{
    "event": "posts.liked",
    "account_id": "acct_123",
    "payload": {
        "id": "123",
        "type": "favorited",
        "createdAt": "2025-05-05T22:22:00+00:00",
        "text": "liked your <a href='https://onlyfans.com/123/username'>post</a>",
        "replacePairs": {
            "{POST_LINK}": "<a href='https://onlyfans.com/123/username'>post</a>"
        },
        "subType": "new_favorite",
        "user_id": "123",
        "isRead": false,
        "canGoToProfile": true,
        "user": {
            "avatar": null,
            "avatarThumbs": null,
            "header": null,
            "headerSize": null,
            "headerThumbs": null,
            "id": 123,
            "name": "Name",
            "username": "username",
            "canLookStory": false,
            "canCommentStory": false,
            "hasNotViewedStory": false,
            "isVerified": false,
            "canPayInternal": false,
            "hasScheduledStream": false,
            "hasStream": false,
            "hasStories": false,
            "tipsEnabled": false,
            "tipsTextEnabled": true,
            "tipsMin": 5,
            "tipsMinInternal": 1,
            "tipsMax": 200,
            "canEarn": false,
            "canAddSubscriber": false,
            "subscribePrice": 0,
            "subscribedBy": false,
            "subscribedOn": false,
            "canReceiveChatMessage": false,
            "hideChat": false,
            "lastSeen": null,
            "isPerformer": false,
            "isRealPerformer": false,
            "view": "mn",
            "canReport": true,
            "subscribedByData": null,
            "subscribedOnData": null,
            "isBlocked": false
        }
    }
}
```

### 💬 Fan is Typing

A fan is typing a message.

```json title="Example data"
{
  "event": "users.typing",
  "account_id": "acct_123",
  "payload": {
    "id": 123
  }
}
```

### ℹ️ Account Connected

A new OnlyFans account was connected.

```json title="Example data"
{
  "event": "accounts.connected",
  "account_id": "acct_123",
  "payload": {
    "state": "authenticated",
    "progress": "started",
    "latestAuthAttempt": {
      "started_at": "2025-05-13T20:26:56.000000Z",
      "completed_at": null,
      "success": false,
      "error_message": null,
      "needs_otp": false,
      "needs_face_otp": false,
      "otp_phone_ending": null
    }
  }
}
```

### ℹ️ Account Reconnected

An OnlyFans account was reconnected.

```json title="Example data"
  {
    "event": "accounts.reconnected",
    "account_id": "acct_123",
    "payload": {
      "state": "authenticated",
      "progress": "started",
      "latestAuthAttempt": {
        "started_at": "2025-05-13T20:26:56.000000Z",
        "completed_at": null,
        "success": false,
        "error_message": null,
        "needs_otp": false,
        "needs_face_otp": false,
        "otp_phone_ending": null
      }
    }
  }
```

### ℹ️ Account Connection Failed

An OnlyFans account's connection has expired, and we couldn't automatically re-connect it using our system.

```json title="Example data"
{
  "event": "accounts.authentication_failed",
  "account_id": "acct_123",
  "payload": {
    "state": "authenticated",
    "progress": "started",
    "latestAuthAttempt": {
      "started_at": "2025-05-13T20:26:56.000000Z",
      "completed_at": null,
      "success": false,
      "error_message": null,
      "needs_otp": false,
      "needs_face_otp": false,
      "otp_phone_ending": null
    }
  }
}
```

### ℹ️ Account Session Expired

An OnlyFans account's connection has expired, but we're automatically re-connecting it using our system — you don't need to do anything.

```json title="Example data"
{
  "event": "accounts.session_expired",
  "account_id": "acct_123",
  "payload": {
    "state": "authenticated",
    "progress": "started",
    "latestAuthAttempt": {
      "started_at": "2025-05-13T20:26:56.000000Z",
      "completed_at": null,
      "success": false,
      "error_message": null,
      "needs_otp": false,
      "needs_face_otp": false,
      "otp_phone_ending": null
    }
  }
}
```

### ℹ️ Account Requires Face Verification

Face verification is required to connect one of your OnlyFans accounts

```json title="Example data"
{
  "event": "accounts.face_otp_required",
  "account_id": "acct_123",
  "payload": {
    "state": "authenticated",
    "progress": "started",
    "face_otp_verification_url": "https://id.onlyfans.com/s?123",
    "latestAuthAttempt": {
      "started_at": "2025-05-13T20:26:56.000000Z",
      "completed_at": null,
      "success": false,
      "error_message": null,
      "needs_otp": false,
      "needs_face_otp": false,
      "otp_phone_ending": null
    }
  }
}
```

### ℹ️ Account Requires OTP (2FA) Code

A two-factor authentication code is required to connect one of your OnlyFans accounts.

```json title="Example data"
{
  "event": "accounts.otp_code_required",
  "account_id": "acct_123",
  "payload": {
    "state": "authenticated",
    "progress": "started",
    "latestAuthAttempt": {
      "started_at": "2025-05-13T20:26:56.000000Z",
      "completed_at": null,
      "success": false,
      "error_message": null,
      "needs_otp": false,
      "needs_face_otp": false,
      "otp_phone_ending": null
    }
  }
}
```

# Zapier & OnlyFans - Quickstart (/integrations/zapier)

import { DownloadIcon, ZapIcon } from "lucide-react";
import { Step, Steps } from "fumadocs-ui/components/steps";
import { Card } from "fumadocs-ui/components/card";

## Prerequisites

To get started, you must have:

* An OnlyFans API account with a creator account connected
* A [Zapier](https://zapier.com) account

## Getting started

<Steps>
  <Step>
    Log in to your Zapier account.
  </Step>

  <Step>
    Install our Zapier app:

    <Card icon={<DownloadIcon className="text-fd-primary" />} href="https://zapier.com/developer/public-invite/227143/bfb7f34aa95032c5d8801a65821e4a5c/" title="Install our Zapier app" className="w-fit">
      It only takes a few seconds.
    </Card>
  </Step>
</Steps>

## Connecting your OnlyFans API account to Zapier

<Steps>
  <Step>
    ### Create a new Zap, or edit an existing one \[!toc]

    <Card icon={<ZapIcon className="text-fd-primary" />} href="https://zapier.com/webintent/create-zap" title="Create new Zap" className="w-fit">
      Build automated OnlyFans workflows by creating your first Zap.
    </Card>
  </Step>

  <Step>
    ### Choose the OnlyFans API App as the trigger \[!toc]

        <img alt="" src={__img0} />
  </Step>

  <Step>
    ### Select a trigger event \[!toc]     <img alt="" src={__img1} />
  </Step>

  <Step>
    ### Create a new API key from the OnlyFans API Console \[!toc]

    <Steps>
      <Step>
        #### Go to the OnlyFans API console -> API Keys \[!toc]

                <img alt="" src={__img2} placeholder="blur" />
      </Step>

      <Step>
        #### Create a new API key from the OnlyFans API Console \[!toc]

                <img alt="" src={__img3} placeholder="blur" />
      </Step>

      <Step>
        #### Give it a name, and press "Add" \[!toc]

                <img alt="" src={__img4} placeholder="blur" />
      </Step>

      <Step>
        #### Copy the API key to your clipboard \[!toc]

                <img alt="" src={__img5} placeholder="blur" />
      </Step>
    </Steps>
  </Step>

  <Step>
    ### Connect Zapier with OnlyFans API \[!toc]     <img alt="" src={__img6} placeholder="blur" />
  </Step>

  <Step>
    ### Paste the API Key into the Zapier connection window \[!toc]

        <img alt="" src={__img7} placeholder="blur" />
  </Step>

  <Step>
    ### Your Zapier account is now connected to OnlyFans API \[!toc] If all went

    well, under "Account", Zapier will show your API key name, and the name of
    your OnlyFans API team.     <img alt="" src={__img8} placeholder="blur" />
  </Step>
</Steps>

<Callout type="success" title="That's it!">
  You're now ready to use the OnlyFans API app in your Zaps.
</Callout>

# Credit System (/introduction/essentials/credits)

import {
  ChartNoAxesCombinedIcon,
  CodeIcon,
  CoinsIcon,
  DatabaseZapIcon,
  FileTextIcon,
  HeartPlusIcon,
  MonitorIcon,
  ScanSearchIcon,
  SquareActivityIcon,
  TrendingUpIcon,
} from "lucide-react";

## Credit calculator

<Card>
  <iframe src="https://ofapi-credit-calculator.pages.dev/" height="400" className="w-full" />
</Card>

## Credit cost overview

Please refer to the table below to get a general overview of the credit cost for our endpoints.

For detailed information about where to find credit information in API responses, see our [Response Structure](/introduction/essentials/response-structure) documentation.

| Endpoint(s)                                                                     | Cost                            | Notes                                                                                                               |
| ------------------------------------------------------------------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| [Search Profiles](/api-reference/public-profiles/search-profiles)               | 1 credit per result             | E.g. if your search query has 10 results, you will be debited 10 credits.                                           |
| [Media Uploading](/api-reference/media/upload-media-to-the-only-fans-cdn)       | 3 credits per MB                | For easy calculation, we use decimal measurements. This means that 1MB is 1,000 KB.                                 |
| [Media Downloading](/api-reference/media/download-media-from-the-only-fans-cdn) | 3 credits per MB                | For easy calculation, we use decimal measurements. This means that 1MB is 1,000 KB.                                 |
| [Webhooks](/webhooks)                                                           | 1 credit per 100 Webhook events | -                                                                                                                   |
| Data Exports (Public Profiles)                                                  | 3 credits per profile           | -                                                                                                                   |
| Data Exports (Other)                                                            | 1 credit per 20 results         | Applies to: Transactions, Chat Messages, Media, Trial Links, Tracking Links, Payouts, Chargebacks, Fans, Followings |
| AI Profile Summaries                                                            | 200 credits per generation      | Applies to both initial generation and re-generation.                                                               |
| [All other uncached responses](#uncached-responses)                             | 1 credit per request            | -                                                                                                                   |
| [All other cached responses](#cached-responses)                                 | 0 credits                       | -                                                                                                                   |

## Cached vs uncached

### Cached responses

Public endpoints make use of automatic caching by default, and thus won't cost you any credits if a cached response already exists.

<Callout>
  **Account-specific endpoints will never be cached**, and will always give you
  a fresh response from OnlyFans.
</Callout>

#### Forcing a fresh response

You can force a fresh response by appending the endpoint URL with `?fresh=true`

### Uncached responses

All account-specific endpoints, and endpoints that reply on real-time data, will always return a fresh response from OnlyFans and thus will consume credits.

## Subscription Plans

Our subscription tiers provide different credit allocations:

<Cards className="grid grid-cols-3 gap-4 @container">
  <Card title="Basic Plan • 25,000 credits per month" href="https://app.onlyfansapi.com/register" cta="Start for free">
    • Perfect for small to medium projects\
    • Includes all basic features\
    • Automatic credit tracking
  </Card>

  <Card title="Pro Plan • 75,000 credits per month" href="https://app.onlyfansapi.com/register" cta="Start for free">
    • Ideal for larger applications\
    • Priority support\
    • Advanced features included
  </Card>

  <Card title="Enterprise Plan • Unlimited credits" href="mailto:hello@onlyfansapi.com" cta="Contact us">
    • Tailored to your needs\
    • Contact us to discuss requirements\
    • Custom features and support
  </Card>
</Cards>

## Credit Features

All subscription tiers include:

<Cards className="grid grid-cols-3 gap-4 @container">
  <Card title="Credit Rollover" icon={<CoinsIcon />}>
    • Up to 200% of monthly allocation\
    • Automatic rollover management\
    • No manual activation required
  </Card>

  <Card title="Usage Monitoring" icon={<ChartNoAxesCombinedIcon />}>
    • Real-time balance tracking\
    • Detailed usage analytics\
    • Automated notifications
  </Card>

  <Card title="Cache Optimization" icon={<DatabaseZapIcon />}>
    • Automatic response caching\
    • Zero-credit cached responses\
    • Cache control with `?fresh=true`
  </Card>
</Cards>

## Monitoring Tools

You can easily track your credit usage through all of our API responses, and through our Console

<Cards>
  <Card title="API Responses" icon={<CodeIcon />}>
    * Real-time credit balance
    * Request-specific credit usage
    * Cache status indicators
  </Card>

  <Card title="Console Analytics" icon={<MonitorIcon />}>
    * Real-time credit balance
    * View your rate limit usage
    * Easily purchase more credits
  </Card>
</Cards>

## Credit Management

Best practices for optimizing credit usage:

<Cards className="grid grid-cols-3 gap-4 @container">
  <Card title="Efficient caching" icon={<DatabaseZapIcon />}>
    Leverage cached responses when possible.
  </Card>

  <Card title="Credit balance monitoring" icon={<SquareActivityIcon />}>
    Monitor your credit balance regularly.
  </Card>

  <Card title="Usage patterns" icon="magnifying-glass" icon={<ScanSearchIcon />}>
    Review usage patterns regularly. Consider optimizing your requests.
  </Card>
</Cards>

<Callout>
  Cached responses are free and don't consume any credits from your balance.
  This applies to public endpoints like profile information.
</Callout>

## Enterprise Solutions

For high-volume requirements, we offer:

<Cards className="grid grid-cols-4 gap-4 @container">
  <Card title="Custom credit packages" icon={<CoinsIcon />} />

  <Card title="Volume-based pricing" icon={<TrendingUpIcon />} />

  <Card title="Priority support access" icon={<HeartPlusIcon />} />

  <Card title="Custom SLA options" icon={<FileTextIcon />} />
</Cards>

Please contact our team to discuss your specific needs and get a tailored solution.

# Endpoint Data Sources (/introduction/essentials/endpoint-data-sources)

import {DatabaseIcon, DatabaseZapIcon, ZapIcon} from "lucide-react";

We classify every endpoint as one of three types:

<Cards className="grid grid-cols-3 gap-4 @container">
  <Card icon={<DatabaseZapIcon className="text-fd-primary" />} title="Hybrid">
    <span className="font-medium text-fd-primary">We make a live request to OnlyFans and then enriches the response</span>
    with fields from the our database (timestamps, tags, computed classifications, etc.).
  </Card>

  <Card icon={<DatabaseIcon className="text-fd-primary" />} title="Computed">
    <span className="font-medium text-fd-primary">We never call OnlyFans during the request.</span>
    The response is built entirely from data we have stored, synced, or calculated.
  </Card>

  <Card icon={<ZapIcon className="text-fd-primary" />} title="Live passthrough">
    <span className="font-medium text-fd-primary">Anything not listed as Hybrid or Computed.</span>
    The response is straight from OnlyFans, with no enrichment.
  </Card>
</Cards>

## Quick answers to common questions

* `GET /{account}/statistics/overview` → **Live passthrough.** The numbers come straight from OnlyFans.
* `GET /{account}/fans/active` → **Hybrid.** OnlyFans response plus a `lastReplyAt` timestamp on each fan, sourced from the OFAPI database.
* `GET /{account}/transactions` → **Hybrid.** OnlyFans response plus a computed `type` field (`subs`, `tips`, `post`, `chat_messages`, `stream`).

## Hybrid endpoints

These endpoints call OnlyFans live and then enrich the response with extra fields from the OFAPI database. The "Enriched with" column lists exactly what OFAPI adds on top of the OnlyFans payload.

| HTTP  | Path                                         | Enriched by OFAPI                                                                                        |
| ----- | -------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `GET` | `/{account}/chats`                           | `lastReplyAt` per chat                                                                                   |
| `GET` | `/{account}/chats/{chat_id}/messages`        | `lastReplyAt` per participant                                                                            |
| `GET` | `/{account}/fans/all`                        | `lastReplyAt` per fan                                                                                    |
| `GET` | `/{account}/fans/active`                     | `lastReplyAt` per fan                                                                                    |
| `GET` | `/{account}/fans/expired`                    | `lastReplyAt` per fan                                                                                    |
| `GET` | `/{account}/fans/latest`                     | `lastReplyAt` per fan                                                                                    |
| `GET` | `/{account}/fans/top`                        | `lastReplyAt` per fan                                                                                    |
| `GET` | `/{account}/users/{username}`                | `lastReplyAt` (if the user is a fan)                                                                     |
| `GET` | `/{account}/transactions`                    | Computed `type` (`subs` / `tips` / `post` / `chat_messages` / `stream`), derived from the OF description |
| `GET` | `/{account}/tracking-links`                  | Tags, cached revenue & spender counts, full campaign URL prefixed with the creator's profile URL         |
| `GET` | `/{account}/trial-links`                     | Tags, cached revenue & spender counts, full campaign URL                                                 |
| `GET` | `/{account}/engagement/messages/top-message` | Engagement stats joined onto the message metadata                                                        |

## Computed endpoints

These endpoints never hit OnlyFans during the request. The response is built entirely from data OFAPI has stored, synced, or calculated.

### Smart Links (analytics + management)

| HTTP     | Path                                       | Notes                                                        |
| -------- | ------------------------------------------ | ------------------------------------------------------------ |
| `GET`    | `/smart-links`                             | List smart links                                             |
| `POST`   | `/smart-links`                             | Create a smart link                                          |
| `GET`    | `/smart-links/{smart_link_id}`             | Fetch a single smart link                                    |
| `DELETE` | `/smart-links/{smart_link_id}`             | Delete a smart link                                          |
| `GET`    | `/smart-links/{smart_link_id}/stats`       | Clicks, subs, revenue, spenders aggregated from OFAPI tables |
| `GET`    | `/smart-links/{smart_link_id}/cohort-arps` | ARPS by acquisition cohort                                   |
| `GET`    | `/smart-links/{smart_link_id}/fans`        | Attributed fans with aggregate metrics                       |
| `GET`    | `/smart-links/{smart_link_id}/spenders`    | Fans where spend `> 0`                                       |
| `GET`    | `/smart-links/{smart_link_id}/clicks`      | Raw click rows                                               |
| `GET`    | `/smart-links/{smart_link_id}/conversions` | Raw conversion rows                                          |

### Stored (cache) link inventory

Explicitly free — these never call OnlyFans.

| HTTP  | Path                                      | Notes                          |
| ----- | ----------------------------------------- | ------------------------------ |
| `GET` | `/{account}/stored/tracking-links`        | Cached tracking links          |
| `GET` | `/{account}/stored/trial-links`           | Cached free trial links        |
| `GET` | `/{account}/stored/shared-tracking-links` | Cached shared tracking links   |
| `GET` | `/{account}/stored/shared-trial-links`    | Cached shared free trial links |

### Webhooks

| HTTP     | Path                                                     | Notes                         |
| -------- | -------------------------------------------------------- | ----------------------------- |
| `GET`    | `/{account}/webhooks`                                    | List webhooks                 |
| `POST`   | `/{account}/webhooks`                                    | Create a webhook              |
| `GET`    | `/{account}/webhooks/{webhook_id}`                       | Fetch a single webhook        |
| `PUT`    | `/{account}/webhooks/{webhook_id}`                       | Update a webhook              |
| `DELETE` | `/{account}/webhooks/{webhook_id}`                       | Delete a webhook              |
| `GET`    | `/{account}/webhooks/events`                             | Enum of available event types |
| `GET`    | `/{account}/webhooks/{webhookEventType}/example-payload` | Static payload generator      |

### Data exports

| HTTP     | Path                                   | Notes                      |
| -------- | -------------------------------------- | -------------------------- |
| `GET`    | `/data-exports`                        | List data exports          |
| `POST`   | `/data-exports`                        | Create a data export       |
| `GET`    | `/data-exports/{data_export_id}`       | Fetch a single data export |
| `POST`   | `/data-exports/{data_export_id}/start` | Start a data export        |
| `DELETE` | `/data-exports/{data_export_id}`       | Delete a data export       |
| `POST`   | `/data-exports/{data_export_id}/retry` | Retry a data export        |

### Link tags

Tags live entirely in the OFAPI database — none of these endpoints touch OnlyFans.

| HTTP     | Path                                                              | Notes                                     |
| -------- | ----------------------------------------------------------------- | ----------------------------------------- |
| `GET`    | `/link-tags`                                                      | List every tag in your org                |
| `GET`    | `/{account}/tracking-links/{tracking_link_id}/tags`               | List tags on a tracking link              |
| `POST`   | `/{account}/tracking-links/{tracking_link_id}/tags`               | Add tags to a tracking link               |
| `DELETE` | `/{account}/tracking-links/{tracking_link_id}/tags`               | Remove tags from a tracking link          |
| `GET`    | `/{account}/trial-links/{trial_link_id}/tags`                     | List tags on a free trial link            |
| `POST`   | `/{account}/trial-links/{trial_link_id}/tags`                     | Add tags to a free trial link             |
| `DELETE` | `/{account}/trial-links/{trial_link_id}/tags`                     | Remove tags from a free trial link        |
| `GET`    | `/{account}/shared-tracking-links/{shared_tracking_link_id}/tags` | List tags on a shared tracking link       |
| `POST`   | `/{account}/shared-tracking-links/{shared_tracking_link_id}/tags` | Add tags to a shared tracking link        |
| `DELETE` | `/{account}/shared-tracking-links/{shared_tracking_link_id}/tags` | Remove tags from a shared tracking link   |
| `GET`    | `/{account}/shared-trial-links/{shared_trial_link_id}/tags`       | List tags on a shared free trial link     |
| `POST`   | `/{account}/shared-trial-links/{shared_trial_link_id}/tags`       | Add tags to a shared free trial link      |
| `DELETE` | `/{account}/shared-trial-links/{shared_trial_link_id}/tags`       | Remove tags from a shared free trial link |

### Auth & accounts

The request itself only reads or writes OFAPI rows; the actual OnlyFans login runs asynchronously in a queued job.

| HTTP     | Path                                               | Notes                             |
| -------- | -------------------------------------------------- | --------------------------------- |
| `GET`    | `/whoami`                                          | Identify the current API key      |
| `GET`    | `/accounts`                                        | List connected OF accounts        |
| `DELETE` | `/accounts/{account}`                              | Disconnect an OF account          |
| `POST`   | `/authenticate`                                    | Start an authentication attempt   |
| `GET`    | `/authenticate/{attempt_id}`                       | Poll attempt status               |
| `PUT`    | `/authenticate/{attempt_id}`                       | Submit credentials / 2FA          |
| `POST`   | `/authenticate/{attempt_id}/send-email-to-creator` | Trigger the OF email-code helper  |
| `POST`   | `/authenticate/{account_id}/reauthenticate`        | Re-auth an existing account       |
| `POST`   | `/client-sessions`                                 | Mint a short-lived client session |

### Media upload status

| HTTP  | Path                                      | Notes                            |
| ----- | ----------------------------------------- | -------------------------------- |
| `GET` | `/{account}/media/upload/{upload}/status` | Poll an in-progress media upload |

## Important clarifications

A couple of endpoints sound like they should be Hybrid or Computed, but aren't. Calling them out here to preempt confusion:

<Callout title="These sound calculated, but are Live passthrough" type="warn">
  The following endpoints return numbers and metrics, but the response is a straight passthrough of what OnlyFans returns — OFAPI does not compute or enrich them:

  * `/statistics/overview`
  * `/statistics/total-transactions`
  * `/statistics/subscriber-metrics`
  * `/me/model-start-date`
  * `/me/top-percentage`
  * `/payouts/balances`
  * `/payouts/eligibility`
  * `/payouts/list-earning-statistics`
  * `/payouts/list-payout-requests`
</Callout>

## Media URLs & file downloads

OnlyFans media files (everything served from `https://cdn*.onlyfans.com/`) get special handling. The first time we see a media file, we save our own copy of it; subsequent requests for that same file are served from our own CDN at `https://cdn.fansapi.com/` instead of contacting OnlyFans.

Two reasons this matters for you:

* **It saves credits.** Once a file is cached, fetching it again does not consume any credits — OnlyFans is never contacted.
* **It's significantly faster.** Our CDN is geographically distributed, so cached files are served from a location close to your end users instead of round-tripping through OnlyFans every time.

This affects two kinds of endpoints.

### Downloading or scraping media files

The endpoints that hand you back actual media bytes — [Download Media](/api-reference/media/download-media-from-the-only-fans-cdn) and the deprecated [Scrape Media](/api-reference/media/deprecated-scrape-media-from-the-only-fans-cdn) — first check whether we already have that file in our own CDN.

* **If we have it cached** → you get a URL on our own `cdn.fansapi.com`. Download Media returns a `302` redirect to it (most HTTP clients follow redirects automatically; `curl` needs `-L`). Scrape Media returns it as `temporary_url` in the response body. **No credits are charged in this case**, because OnlyFans is never contacted.
* **If we don't have it cached yet** → we stream the bytes from OnlyFans straight back to you as the response, and at the same time start saving our own copy. The next time anyone asks for that same file, it will be served from our CDN.

### Endpoints that return media URLs in their response

Any endpoint that returns OnlyFans CDN URLs in its response body — List Chat Messages, List Posts, List Vault Media, and so on — follows the same caching pattern, applied per-URL:

* Each `https://cdn*.onlyfans.com/*` URL in the response is checked against our CDN.
* **URLs we already have cached** are replaced with the equivalent `https://cdn.fansapi.com/*` URL before the response is returned to you.
* **URLs we don't have cached yet** are left as the original `https://cdn*.onlyfans.com/*` URL, and we start saving our own copy. Future responses that include the same URL will return the `cdn.fansapi.com` version instead.

This rewriting is applied per-URL, so a single response can contain any mix of OnlyFans CDN URLs and rewritten `cdn.fansapi.com` URLs depending on what we've already cached.

## Anything not listed here

If an endpoint isn't listed on this page, **treat it as a Live passthrough.** The response is the OnlyFans payload, unmodified by OFAPI.

{/*
  Maintainer note — to keep this page accurate, in the OFAPI app repo:

  - The Hybrid list is exactly the set of `formatWith(...)` callsites under
  `app/Http/Controllers/`. Run:
    grep -rn "formatWith" app --include="*.php"
  to find them.
  - The Computed list is API controllers (registered in `routes/api.php`) that do
  not inject `ApiOnlyFansClientForAccount`. Run:
    grep -rL "ApiOnlyFansClientForAccount" app/Http/Controllers/Api
  to find candidates.
  */}

# Proxies (/introduction/essentials/proxies)

## Proxy Infrastructure

OnlyFans API leverages an advanced proxy architecture to ensure high-availability connections and robust security. Our infrastructure automatically manages dedicated proxy assignments for each account, providing enterprise-grade reliability and performance.

### Built-in Proxy System (Recommended)

We provide a sophisticated proxy management system at no additional cost:

* **Dedicated Mobile IP**: Each connected account gets its own exclusive mobile proxy IP
* **Intelligent Routing**: Advanced traffic routing optimized for OnlyFans platform
* **Geographic Distribution**: Choose your preferred proxy country during setup (currently US and UK)
* **Zero Configuration**: Everything is handled automatically

<Callout type="warn">
  Other proxy countries (DE, FR, IT) have been temporarily removed due to OnlyFans restrictions. Only US and UK proxies are currently available.
</Callout>

<Callout>
  Our proxy infrastructure is specifically engineered for optimal OnlyFans API
  performance. We recommend using our built-in system for the best experience.
</Callout>

### Custom Proxy Integration

For organizations with existing proxy infrastructure:

1. Select "Use custom proxy" during account configuration
2. Configure your proxy details:
   * Host
   * Port
   * Username (if required)
   * Password (if required)

### Technical Requirements

Custom proxy configurations must meet these specifications:

* **IP Exclusivity**: Dedicated, non-shared IP address per account
* **Network Type**: Mobile or residential IP ranges (datacenter IPs not supported)
* **Geolocation**: IP geolocation matching historical access patterns
* **Protocol Support**: HTTP/HTTPS protocols

### Best Practices

* Maintain consistent geolocation patterns
* Use the same proxy consistently for each account
* Monitor proxy health metrics
* Contact support if you experience connection issues

# Rate Limits (/introduction/essentials/rate-limits)

<Callout title="We have removed our daily rate limits!" type="warn">
  We have decided to remove our daily rate limits. Please remove any references to these values in your integrations.
</Callout>

## Rate Limiting Overview

Our platform employs a distributed rate limiting system to ensure optimal performance and resource allocation. Rate limits vary based on your subscription plan:

### Plan-Based Limits

1. **Basic Plan**:

   * 1,000 requests per minute (RPM)
   * Resets every minute
   * Perfect for most applications
   * Tracked via `remaining_minute` counter

2. **Pro Plan**:

   * 5,000 requests per minute (RPM)
   * Higher throughput for demanding applications
   * Priority request processing
   * Tracked via `remaining_minute` counter

3. **Enterprise Plan**:
   * No rate limits
   * Unlimited requests per minute
   * Custom infrastructure
   * Performance monitoring included

<Callout>
  Enterprise customers get unlimited request throughput with dedicated
  infrastructure to ensure optimal performance at any scale.
</Callout>

For information about where to find rate limit data in responses, see our [Response Structure](/introduction/essentials/response-structure) documentation.

### Caching and Rate Limits

Our caching system helps you optimize your rate limit usage:

* Public endpoints (like profile information) are automatically cached
* Cached responses don't count towards your rate limits
* Use `?fresh=true` when you need real-time data
* Cache duration varies by endpoint type

<Callout>
  When using cached responses, you're not consuming any of your rate limits,
  making it an effective way to optimize your API usage.
</Callout>

### Rate Limit Monitoring

Track your rate limit usage through:

1. **Response Headers**

   * Current limits
   * Remaining requests
   * Reset timers

2. **Dashboard Analytics**
   * Usage patterns
   * Peak usage times
   * Rate limit warnings

### Best Practices

Implement these strategies for optimal throughput:

1. **Monitor Your Limits**

   * Track usage patterns
   * Plan for limit resets
   * Set up alerts before limits are reached

2. **Optimize Request Patterns**

   * Distribute requests evenly
   * Avoid request bursts
   * Use batch operations when available

3. **Handle Rate Limits Gracefully**

   * Implement exponential backoff
   * Queue requests when near limits
   * Use cached responses when possible

4. **Cache Strategy**
   * Leverage cached responses
   * Only use `?fresh=true` when necessary
   * Implement local caching when appropriate

### Error Handling

When you exceed rate limits:

* Response will have status code `429 Too Many Requests`
* Contains information about when limits reset
* Implement automatic retry with backoff

Example backoff strategy:

```javascript
async function fetchWithRetry(url, maxRetries = 3) {
  for (let i = 0; i < maxRetries; i++) {
    try {
      const response = await fetch(url);
      if (response.status !== 429) return response;

      // Get retry delay from headers or use exponential backoff
      const retryAfter = response.headers.get("retry-after") || Math.pow(2, i);
      await new Promise((resolve) => setTimeout(resolve, retryAfter * 1000));
    } catch (error) {
      if (i === maxRetries - 1) throw error;
    }
  }
}
```

### Enterprise Options

For high-volume requirements:

* No rate limits
* Dedicated infrastructure
* Custom performance tuning
* Advanced monitoring tools

Contact our enterprise team to discuss your specific needs.

# Response Structure (/introduction/essentials/response-structure)

## Response Format

Every API response follows a consistent structure with two main components:

1. The `data` field containing OnlyFans information
2. Optional `_pagination` field with pagination information, if the endpoint is paginated
3. The `_meta` object containing request metadata

Here's an example response:

### Response Body Structure

<Callout title="We have removed our daily rate limits!" type="warn">
  We have decided to remove our daily rate limits. Please remove any references to these values in your integrations.
</Callout>

```json
{
  "data": {
    // OnlyFans response data
    "view": "f",
    "avatar": "https://...",
    "isFriend": false,
    "isBlocked": false,
    "canReport": false
  },
  "_meta": {
    "_credits": {
      "used": 0,
      "balance": 9852,
      "note": "Cache HIT. No credits debited"
    },
    "_cache": {
      "is_cached": true,
      "cached_at": "2025-01-29T16:30:43+00:00",
      "note": "Add ?fresh=true to the request URL to skip the cache and get a fresh response from OnlyFans"
    },
    "_rate_limits": {
      "limit_minute": 60,
      "limit_day": null, // Legacy
      "remaining_minute": 59,
      "remaining_day": null, // Legacy
      "notice": "We have decided to remove our daily rate limits. Please remove any references to this in your integrations."
    }
  }
}
```

### The `data` Field

The `data` field always contains the actual OnlyFans response data. Its structure varies depending on the endpoint being called. For example:

* Profile information for `/profiles/{username}`
* Message data for `/messages` endpoints
* Subscriber data for `/subscribers` endpoints

<Callout title="Not every field in `data` comes straight from OnlyFans">
  Some endpoints are **Hybrid** (live OnlyFans response enriched with extra fields from our database) or **Computed** (built entirely from data we've stored or calculated). See [Endpoint data sources](/introduction/essentials/endpoint-data-sources) for the exhaustive breakdown of which endpoints fall into each category.
</Callout>

### The optional `_pagination` field

Some endpoints return paginated data. For example, `/chats`, `/chats/XYZ/messages` or `/tracking-links`.

In this case, the response will include a `_pagination` field with the `next_page` field that you can use to fetch the next page of results.

If there are no more pages, the `next_page` field will be `null`.

```json
{
  "data": {
    // OnlyFans response data
  },
  "_meta": {
    "_pagination": {
      "next_page": "https://app.onlyfansapi.com/api/acct_XXXXXXXXXXX/chats/?offset=10&limit=10"
    }
  }
}
```

### The `_meta` Object

The `_meta` object contains three sections of metadata about your request:

1. **`_credits`**: Credit usage information

   * `used`: Credits consumed by this request
   * `balance`: Your remaining credit balance
   * `note`: Additional information about credit usage

2. **`_cache`**: Caching status and information

   * `is_cached`: Whether this response was served from cache
   * `cached_at`: When the response was cached
   * `note`: Instructions for bypassing cache if needed

3. **`_rate_limits`**: Rate limiting information
   * `limit_minute`: Requests allowed per minute
   * `limit_day`: Legacy: Requests allowed per day **(removed)**
   * `remaining_minute`: Remaining requests this minute
   * `remaining_day`: Legacy: Remaining requests today **(removed)**

## Response Headers

Each response includes comprehensive metadata in the headers:

| Header                          | Value              | Category           | Description                   |
| ------------------------------- | ------------------ | ------------------ | ----------------------------- |
| `content-type`                  | `application/json` | Content Headers    | Always `application/json`     |
| `x-ofapi-credits-balance`       | `9852`             | Credit Headers     | Your remaining credit balance |
| `x-ofapi-credits-used`          | `0`                | Credit Headers     | Credits used by this request  |
| `x-ofapi-is-cached`             | `true`             | Credit Headers     | Whether response was cached   |
| `x-rate-limit-limit-day`        | `1000`             | Rate Limit Headers | **Legacy: Removed**           |
| `x-rate-limit-limit-minute`     | `60`               | Rate Limit Headers | Per-minute limit              |
| `x-rate-limit-remaining-day`    | `988`              | Rate Limit Headers | **Legacy: Removed**           |
| `x-rate-limit-remaining-minute` | `59`               | Rate Limit Headers | Remaining minute requests     |

## Cache Control

You can control caching behavior using query parameters:

* By default, responses are cached when possible (only for public endpoints)
* Add `?fresh=true` to force a fresh response from OnlyFans
* Cached responses don't consume credits
* Cache duration varies by endpoint

<Callout>
  The same information is available in both headers and the `_meta` object. Use
  headers for quick access in code, and the `_meta` object for more detailed
  information including notes and timestamps.
</Callout>

# Team roles & permissions (/introduction/essentials/team-roles-and-permissions)

Your team in the [dashboard](https://app.onlyfansapi.com) can have as many members as you need, and every member is assigned a **role** that determines what they can see and do. This page explains each role, the permissions it grants by default, the full list of available permissions, and how to build your own custom roles.

## How roles & permissions work

* A team has **one Owner** and any number of members. Each member is assigned a single **role**.
* The **Owner** always has every permission. Ownership is set when the team is created or via an ownership transfer — it **cannot** be assigned by invite.
* **Permissions are granular** and named `category.action` (for example, `smart-links.manage`). A role is simply a named bundle of default permissions.
* **Extra permissions** can be granted on top of a role's defaults. These are additive — for example, you can give a Viewer one extra capability without switching them to a Custom role.
* A **Custom role** has no default permissions. You build it up entirely by ticking individual permissions from the grouped list.
* A member's **effective permissions** = their role's defaults **+** any extra permissions granted to them.

<Callout type="info">
  The roles you can assign when inviting or editing a member are **Admin**,
  **Member**, **Developer**, **Viewer**, and **Custom**. The **Owner** role is
  not in this list — it is set only at team creation or via ownership transfer.
</Callout>

## Choosing a role

| Role          | Summary                                                                                                                                                           |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Owner**     | Full control over the team, billing, and all settings. Always has every permission. Set at team creation or via ownership transfer; cannot be assigned by invite. |
| **Admin**     | Full access to everything except deleting the team.                                                                                                               |
| **Member**    | Create and manage accounts, links, pixels, reports, and creator tools. No team-management or billing access.                                                      |
| **Developer** | Create and use API keys, webhooks, and integrations. Mostly view-only on creator features.                                                                        |
| **Viewer**    | View-only access to all data and reports.                                                                                                                         |
| **Custom**    | A custom set of permissions you choose yourself.                                                                                                                  |

When deciding which role to assign:

* **Admin** — for trusted co-managers who should be able to do everything you can, except delete the team. Admin equals every permission except *Delete the team*.
* **Member** — for day-to-day operators. They get full operational access to accounts, links, pixels, free trials, reports, and developer/AI/creator tools, but **no** team management, **no** billing, and they **cannot** purchase credits.
* **Developer** — for engineers integrating with the API. They get full control of API keys, webhooks, integrations, and data exports, but are view-only on creator features (accounts, smart links, free trials, and so on).
* **Viewer** — for stakeholders who only need to look. Their defaults are exactly "all view permissions" — every `*.view` capability and nothing that creates, edits, deletes, or manages.
* **Custom** — when none of the presets fit. A Custom role starts empty; you tick individual permissions from the grouped list below.

<Callout>
  Need a role that's *almost* right? Instead of building a Custom role from
  scratch, assign the closest preset and grant a few **extra permissions** on
  top. See [Custom roles & extra permissions](#custom-roles--extra-permissions).
</Callout>

## Permissions reference

The tables below list every available permission, grouped by category. Each row shows what the permission allows, its internal key (useful for API and role automation), and whether each role gets it **by default** (✓) or not (—).

The **Owner** is granted every permission, so it is ✓ on every row. **Custom** roles start with **no** default permissions and are therefore omitted from the matrix.

### Team Management

| Permission                    | Allows                            | Key                   | Owner | Admin | Member | Developer | Viewer |
| ----------------------------- | --------------------------------- | --------------------- | :---: | :---: | :----: | :-------: | :----: |
| Edit team name & settings     | Edit the team's name and settings | `team.update`         |   ✓   |   ✓   |    —   |     —     |    —   |
| Delete the team               | Permanently delete the team       | `team.delete`         |   ✓   |   —   |    —   |     —     |    —   |
| View team members             | See the list of team members      | `team.members.view`   |   ✓   |   ✓   |    —   |     —     |    ✓   |
| Invite, remove & change roles | Manage team membership and roles  | `team.members.manage` |   ✓   |   ✓   |    —   |     —     |    —   |

### Billing & Credits

| Permission                          | Allows                                           | Key              | Owner | Admin | Member | Developer | Viewer |
| ----------------------------------- | ------------------------------------------------ | ---------------- | :---: | :---: | :----: | :-------: | :----: |
| View plans, invoices & payment info | See billing plans, invoices, and payment details | `billing.view`   |   ✓   |   ✓   |    —   |     —     |    ✓   |
| Subscribe, cancel & manage payments | Subscribe, cancel, and manage payment methods    | `billing.manage` |   ✓   |   ✓   |    —   |     —     |    —   |
| View credit balance                 | See the current credit balance                   | `credits.view`   |   ✓   |   ✓   |    ✓   |     ✓     |    ✓   |
| Purchase credits                    | Buy additional credits                           | `credits.topup`  |   ✓   |   ✓   |    —   |     —     |    —   |
| View API usage & credit history     | See API usage and credit history                 | `usage.view`     |   ✓   |   ✓   |    ✓   |     ✓     |    ✓   |

### OnlyFans Accounts

| Permission                  | Allows                             | Key               | Owner | Admin | Member | Developer | Viewer |
| --------------------------- | ---------------------------------- | ----------------- | :---: | :---: | :----: | :-------: | :----: |
| View accounts               | See connected OnlyFans accounts    | `accounts.view`   |   ✓   |   ✓   |    ✓   |     ✓     |    ✓   |
| Add, edit & delete accounts | Connect, edit, and remove accounts | `accounts.manage` |   ✓   |   ✓   |    ✓   |     —     |    —   |

### Smart Links

| Permission                        | Allows                            | Key                  | Owner | Admin | Member | Developer | Viewer |
| --------------------------------- | --------------------------------- | -------------------- | :---: | :---: | :----: | :-------: | :----: |
| View smart links & reports        | See smart links and their reports | `smart-links.view`   |   ✓   |   ✓   |    ✓   |     ✓     |    ✓   |
| Create, edit & delete smart links | Manage smart links                | `smart-links.manage` |   ✓   |   ✓   |    ✓   |     —     |    —   |

### Postbacks

| Permission                      | Allows                   | Key                | Owner | Admin | Member | Developer | Viewer |
| ------------------------------- | ------------------------ | ------------------ | :---: | :---: | :----: | :-------: | :----: |
| View postbacks                  | See configured postbacks | `postbacks.view`   |   ✓   |   ✓   |    ✓   |     ✓     |    ✓   |
| Create, edit & delete postbacks | Manage postbacks         | `postbacks.manage` |   ✓   |   ✓   |    ✓   |     —     |    —   |

### Meta Pixels

| Permission                        | Allows                     | Key                  | Owner | Admin | Member | Developer | Viewer |
| --------------------------------- | -------------------------- | -------------------- | :---: | :---: | :----: | :-------: | :----: |
| View meta pixels                  | See configured meta pixels | `meta-pixels.view`   |   ✓   |   ✓   |    ✓   |     ✓     |    ✓   |
| Create, edit & delete meta pixels | Manage meta pixels         | `meta-pixels.manage` |   ✓   |   ✓   |    ✓   |     —     |    —   |

### Free Trials

| Permission                        | Allows                              | Key                  | Owner | Admin | Member | Developer | Viewer |
| --------------------------------- | ----------------------------------- | -------------------- | :---: | :---: | :----: | :-------: | :----: |
| View free trials & analytics      | See free trials and their analytics | `free-trials.view`   |   ✓   |   ✓   |    ✓   |     ✓     |    ✓   |
| Create, edit & delete free trials | Manage free trials                  | `free-trials.manage` |   ✓   |   ✓   |    ✓   |     —     |    —   |

### Tracking Links

| Permission                           | Allows                                 | Key                     | Owner | Admin | Member | Developer | Viewer |
| ------------------------------------ | -------------------------------------- | ----------------------- | :---: | :---: | :----: | :-------: | :----: |
| View tracking links & analytics      | See tracking links and their analytics | `tracking-links.view`   |   ✓   |   ✓   |    ✓   |     ✓     |    ✓   |
| Create, edit & delete tracking links | Manage tracking links                  | `tracking-links.manage` |   ✓   |   ✓   |    ✓   |     —     |    —   |

### API Keys & Logs

| Permission                     | Allows                                | Key                 | Owner | Admin | Member | Developer | Viewer |
| ------------------------------ | ------------------------------------- | ------------------- | :---: | :---: | :----: | :-------: | :----: |
| View API keys                  | See API keys                          | `api-keys.view`     |   ✓   |   ✓   |    ✓   |     ✓     |    ✓   |
| Create, edit & delete API keys | Manage API keys                       | `api-keys.manage`   |   ✓   |   ✓   |    ✓   |     ✓     |    —   |
| View request logs              | See API request logs                  | `logs.view`         |   ✓   |   ✓   |    ✓   |     ✓     |    ✓   |
| Use API playground             | Access the interactive API playground | `playground.access` |   ✓   |   ✓   |    ✓   |     ✓     |    —   |

### Webhooks

| Permission                     | Allows                  | Key               | Owner | Admin | Member | Developer | Viewer |
| ------------------------------ | ----------------------- | ----------------- | :---: | :---: | :----: | :-------: | :----: |
| View webhooks                  | See configured webhooks | `webhooks.view`   |   ✓   |   ✓   |    ✓   |     ✓     |    ✓   |
| Create, edit & delete webhooks | Manage webhooks         | `webhooks.manage` |   ✓   |   ✓   |    ✓   |     ✓     |    —   |

### Integrations

| Permission                             | Allows                                | Key                        | Owner | Admin | Member | Developer | Viewer |
| -------------------------------------- | ------------------------------------- | -------------------------- | :---: | :---: | :----: | :-------: | :----: |
| View team integrations                 | See team integrations                 | `team-integrations.view`   |   ✓   |   ✓   |    ✓   |     ✓     |    ✓   |
| Manage team integrations               | Manage team integrations              | `team-integrations.manage` |   ✓   |   ✓   |    ✓   |     ✓     |    —   |
| Configure MCP / AI client integrations | Set up MCP and AI client integrations | `mcp.configure`            |   ✓   |   ✓   |    ✓   |     ✓     |    —   |

### AI Analytics

| Permission                        | Allows                                 | Key                            | Owner | Admin | Member | Developer | Viewer |
| --------------------------------- | -------------------------------------- | ------------------------------ | :---: | :---: | :----: | :-------: | :----: |
| View AI Analytics                 | See AI Analytics                       | `ai-analytics.view`            |   ✓   |   ✓   |    ✓   |     ✓     |    ✓   |
| View AI fan profile summaries     | See AI-generated fan profile summaries | `fan-profile-summary.view`     |   ✓   |   ✓   |    ✓   |     ✓     |    ✓   |
| Generate AI fan profile summaries | Generate AI fan profile summaries      | `fan-profile-summary.generate` |   ✓   |   ✓   |    ✓   |     —     |    —   |
| View fan notes                    | See fan notes                          | `fan-notes.view`               |   ✓   |   ✓   |    ✓   |     ✓     |    ✓   |
| Edit fan notes                    | Create and edit fan notes              | `fan-notes.manage`             |   ✓   |   ✓   |    ✓   |     —     |    —   |
| Configure daily payouts           | Configure daily payouts                | `daily-payouts.manage`         |   ✓   |   ✓   |    ✓   |     —     |    —   |

### Data Exports

| Permission                     | Allows                           | Key                  | Owner | Admin | Member | Developer | Viewer |
| ------------------------------ | -------------------------------- | -------------------- | :---: | :---: | :----: | :-------: | :----: |
| View data exports              | See data exports                 | `data-export.view`   |   ✓   |   ✓   |    ✓   |     ✓     |    ✓   |
| Create & download data exports | Create and download data exports | `data-export.manage` |   ✓   |   ✓   |    ✓   |     ✓     |    —   |

### Tools

| Permission                      | Allows                           | Key                   | Owner | Admin | Member | Developer | Viewer |
| ------------------------------- | -------------------------------- | --------------------- | :---: | :---: | :----: | :-------: | :----: |
| View AI voice messages          | See AI voice messages            | `ai-voice.view`       |   ✓   |   ✓   |    ✓   |     ✓     |    ✓   |
| Create & edit AI voice messages | Manage AI voice messages         | `ai-voice.manage`     |   ✓   |   ✓   |    ✓   |     —     |    —   |
| View housekeeping               | See housekeeping                 | `housekeeping.view`   |   ✓   |   ✓   |    ✓   |     ✓     |    ✓   |
| Start & configure housekeeping  | Start and configure housekeeping | `housekeeping.manage` |   ✓   |   ✓   |    ✓   |     —     |    —   |

## Custom roles & extra permissions

When the presets don't fit, you have two options:

### Custom roles

A **Custom** role starts with **no** permissions. You build it up entirely by ticking individual permissions from the grouped list above. Use this when a member needs a unique combination of capabilities that none of the presets provide.

### Extra permissions

Any role can be granted **individual extra permissions** beyond its defaults. These are **additive**, so you don't have to switch a member to a Custom role just to give them one more capability — for example, you can grant a **Viewer** a single `*.manage` permission while keeping all their view-only defaults.

A member's **effective access** is always: **role defaults** + **any extra permissions granted to them**

<Callout type="info" title="Email notification defaults">
  By default, **Owner**, **Admin**, and **Member** roles receive
  authentication-action-required emails (for example, when an account needs
  re-authentication).
</Callout>

# ChatGPT x OnlyFans (/onlyfans-ai/mcp/chatgpt)

import { Accordion, Accordions } from "fumadocs-ui/components/accordion";

<img alt="ChatGPT × OnlyFans MCP" src={__img0} placeholder="blur" />

## What this does

ChatGPT can call OnlyFans API endpoints directly through the OnlyFans MCP server. Add it once as a custom connector, then build a **Custom GPT** for your team or fire off **Agent Mode** to run scheduled work overnight.

Works with **Custom GPTs**, **Agent Mode**, **Deep Research**, and any chat with the connector enabled.

<Callout type="warn">
  ChatGPT custom connectors require a paid plan with MCP support — **Pro**, **Business**, or **Enterprise**. Free and Plus do not yet support custom MCP connectors.
</Callout>

## Prerequisites

* An [OnlyFans API](https://app.onlyfansapi.com) account
* A paid ChatGPT plan (**Pro**, **Business**, or **Enterprise**)
* At least one [connected OnlyFans account](/introduction/guides/connect-onlyfans-account)

<Callout>
  On **Business** and **Enterprise**, an admin can approve the connector once and roll it out to every seat in your workspace.
</Callout>

## Step-by-step

### 1. Open ChatGPT Settings → Connectors

In ChatGPT, click your profile → **Settings** → **Connectors** → **Create**.

### 2. Add a custom connector

Enter these details:

* **Name** — `OnlyFans MCP` (or any label you prefer)
* **MCP server URL**:

```
https://app.onlyfansapi.com/mcp/onlyfans-mcp
```

* **Authentication** — set to **OAuth**

<Callout type="warn">
  The OnlyFans MCP server expects **OAuth** for ChatGPT connectors. Don't pick "No authentication" — the connector will fail.
</Callout>

### 3. Click "Connect" and finish OAuth

ChatGPT redirects you to **app.onlyfansapi.com**. Click **Authorize**.

You'll land back in ChatGPT with the connector marked as connected. Done — your agent now has 350+ tools across chats, fans, and earnings.

<Callout>
  Sign in to [app.onlyfansapi.com](https://app.onlyfansapi.com) in a separate tab first, so the OAuth flow doesn't stall on the sign-in page.
</Callout>

### 4. Enable the connector in a chat

Open a new chat. Click the tools picker → toggle **OnlyFans MCP** on.

## Build a Custom GPT for your agency

In ChatGPT, go to **Explore GPTs** → **Create** → **Configure**. Drop this into **Instructions**, attach the OnlyFans MCP connector under **Tools**, and share with your team.

Replace `{{Agency Name}}` with your agency:

```
You are an OnlyFans agency analyst working for {{Agency Name}}.

You have access to:
- The OnlyFans MCP server — search the docs for endpoints, schemas, and webhook events.
- The onlyfansapi-skill — call REST endpoints to read chats, fans, earnings, and trigger mass messages.

Rules:
- Always check the docs first when unsure of a parameter.
- Use UTC timestamps. Always quote the source endpoint and parameters in your final answer.
- For revenue questions, group by creator account unless the user says otherwise.
- For mass-message drafts, output text only — never auto-send. The user reviews and dispatches.
- Surface chargebacks, refunds, and unusual spend patterns proactively.

Tone: concise, numeric, agency-operator-friendly. No emojis unless asked.
```

<Callout>
  A Custom GPT replaces a recurring n8n / Zapier workflow with one URL your team can open from any device.
</Callout>

## Run scheduled work in Agent Mode

Agent Mode is ChatGPT's autonomous workspace — it can plan, run tools, and iterate over multi-step tasks. Use it to ship a daily revenue digest with zero human touch:

```
Every morning at 8am UTC, draft a Slack-ready report of last 24h revenue per creator.
Flag any chargeback over $50, any creator whose revenue dropped >25% vs yesterday,
and any whale who didn't message yesterday. Output as markdown.
```

<Callout type="warn">
  Configure tool approvals so **write actions** (mass-message, label updates) require a human OK. Read-only actions (earnings, fan lookups) can run unattended.
</Callout>

## Run cohort analysis in Deep Research

Deep Research is ChatGPT's long-form research agent — perfect for cohort analysis across hundreds of fans:

```
Research churn drivers across my top 100 fans this quarter.
Pull last_active, total_spend, message_count, and tags from the OnlyFans API REST endpoints.
Cluster the churned cohort vs the retained cohort and surface 3 hypotheses ranked by lift.
```

## Example use cases

8 prompts that replace daily ops grunt work. Drop them into your Custom GPT or any ChatGPT conversation with the connector enabled:

* *"Pull this week's revenue per creator and chart it."* — replaces the Monday-morning spreadsheet build
* *"List my top 50 spenders with their last message timestamp."* — no more switching dashboards per creator
* *"Find every fan flagged for chargeback in the last 30 days."* — catch chargeback patterns before finance does
* *"Draft a renewal DM for fans churning in the next 7 days. No auto-send."* — agent drafts, your team approves and ships
* *"Compare PPV conversion rates across my creators this month."* — see which creator's offers are working
* *"Build a daily report for Slack: revenue, top fans, chat backlog."* — one Custom GPT replaces a recurring n8n workflow
* *"Identify whales who haven't messaged in 14 days — draft a re-engagement."* — reactivate dormant high-spenders before they unsub
* *"Export all transactions over $200 from last quarter as CSV."* — accounting stops chasing you for reports

<Callout>
  Most tools are **account-scoped** and need the account id in the form `acct_XXXXXXXXXXXXXXX`. If you omit it, ChatGPT will ask — or it will call `list_accounts` first to find one.
</Callout>

## Troubleshooting

<Accordions type="single">
  <Accordion title="Connector won't connect — 'Authentication failed'">
    Check that **Authentication** is set to **OAuth** (not "No authentication"). Sign in to [app.onlyfansapi.com](https://app.onlyfansapi.com) in a separate tab first, then retry.
  </Accordion>

  <Accordion title="Tool calls return 429 Too Many Requests">
    MCP calls are rate-limited to **120 requests/minute** per API key. Wait a minute and retry. If you hit this often, split work across multiple API keys.
  </Accordion>

  <Accordion title="ChatGPT doesn't see the OnlyFans tools">
    The connector is toggled off in that conversation. Open the tools picker and toggle **OnlyFans MCP** on.
  </Accordion>

  <Accordion title="I'm on Free or Plus and don't see Connectors">
    Custom MCP connectors require **Pro**, **Business**, or **Enterprise**. Upgrade your plan, or use [Claude](/onlyfans-ai/mcp/claude) instead — Claude supports custom connectors on every paid plan.
  </Accordion>
</Accordions>

## See also

* [OnlyFans MCP overview](/onlyfans-ai/mcp) — what MCP is, how it works, and supported clients
* [Claude MCP install guide](/onlyfans-ai/mcp/claude)
* [Manus MCP install guide](/onlyfans-ai/mcp/manus)
* [Develop with AI Agents](/introduction/guides/develop-with-ai-agents) — `llms.txt`, OpenAPI schema, `onlyfansapi-skill`
* [API Reference](/api-reference) — every endpoint exposed as an MCP tool

# Claude x OnlyFans (/onlyfans-ai/mcp/claude)

import { Accordion, Accordions } from "fumadocs-ui/components/accordion";

## What this does

Claude can call OnlyFans API endpoints directly — send messages, pull stats, manage posts — through the OnlyFans MCP server. Add it once as a **custom connector** in Claude, then ask Claude to run OnlyFans tasks in plain English from any chat.

Works with **Claude Desktop**, **Claude.ai (web)**, **Claude Code**, and the **Anthropic API**.

<Callout>
  Custom connectors are currently in **beta** on Claude. All Claude plans support them (Free is capped at 1 custom connector; Pro/Max/Team/Enterprise allow multiple).
</Callout>

## Prerequisites

* A [Claude.ai](https://claude.ai) account
* An [OnlyFans API](https://app.onlyfansapi.com) account
* At least one [connected OnlyFans account](/introduction/guides/connect-onlyfans-account)

## Step-by-step

### 1. Open Claude Settings → Customize → Connectors

In Claude.ai, click your profile → **Settings** → **Customize** → **Connectors**.

### 2. Add a custom connector

Click the **+** icon at the top of the Connectors list to open **Add custom connector**. Enter:

* **Name** — `OnlyFans MCP` (or any label you prefer)
* **Remote MCP server URL**:

```
https://app.onlyfansapi.com/mcp/onlyfans-mcp
```

Leave **Advanced settings** closed, then click **Add**.

<img alt="Claude — Add custom connector dialog" src={__img0} placeholder="blur" />

<Callout>
  The **Advanced settings** (OAuth Client ID / Secret) stay empty. Our server handles OAuth automatically.
</Callout>

### 3. Click "Connect"

The new connector opens to a "You are not connected to OnlyFans MCP yet." screen. Click **Connect** to start the OAuth flow.

<img alt="Claude — Connect button" src={__img1} placeholder="blur" />

<Callout type="warn">
  **Sign in to [app.onlyfansapi.com](https://app.onlyfansapi.com) in a separate tab first.** If you're signed out when you click **Connect**, Claude sends you to the sign-in page — but once you sign in, you land on the dashboard instead of the OAuth authorize screen, and the flow stalls. Sign in first, then come back to Claude and click **Connect**.
</Callout>

### 4. Authorize Claude on OnlyFans API

Claude redirects you to **app.onlyfansapi.com**. Click **Authorize**.

<img alt="OnlyFans API — Authorize access" src={__img2} placeholder="blur" />

The button changes to **Redirecting to Claude…** and sends you back automatically.

<img alt="OnlyFans API — Redirecting to Claude" src={__img3} placeholder="blur" />

### 5. Connector shows "Connected"

Back in Claude, you see a **Connected to OnlyFans MCP** toast and the connector's tool permissions list (all 350+ tools, organized by Read-only / Write / Destructive).

<img alt="Claude — Connector connected with tool permissions" src={__img4} placeholder="blur" />

<Callout>
  Tool permissions default to **Needs approval** — Claude asks before each tool call. You can switch a tool (or the whole group) to **Always allow** here, or do it inline on first use.
</Callout>

### 6. Enable the connector in a chat

Open a new chat. Click the **+** button in the composer → **Connectors** → toggle **OnlyFans MCP** on.

<img alt="Claude — Enable connector in chat" src={__img5} placeholder="blur" />

### 7. Prompt Claude — approve the first tool call

Ask Claude to do something. On the first tool call, Claude shows a **"Claude wants to use \<tool> from OnlyFans MCP"** prompt. Click **Always allow** (or **Deny**).

<img alt="Claude — Approve tool call" src={__img6} placeholder="blur" />

Done. Claude can now drive your OnlyFans accounts through the API.

## Example use cases

Drop these prompts into a Claude chat with the OnlyFans MCP connector enabled:

### Reporting & analytics

* *"Summarize today's PPV revenue per creator."*
* *"List my top 20 spenders this week with their last message timestamp."*
* *"Get the earnings for `acct_XXXXXXXXXXXXXXX` this month, broken down by day."*
* *"Pull last quarter's chargebacks and group them by reason."*
* *"Build a daily Slack-ready report: revenue, top fans, chat backlog."*

### Fan & chat ops

* *"Find every chat with no reply in 24h and surface them."*
* *"Show my top 20 spending fans for `acct_XXXXXXXXXXXXXXX` in the last 30 days."*
* *"Tag whales spending over $500 with the `vip` label."*
* *"Identify whales who haven't messaged in 14 days — draft a re-engagement DM."*

### Mass messaging & monetization

* *"Draft a renewal DM for fans churning in the next 7 days. Don't auto-send."*
* *"Mass-message expired subs with a 50% reactivation offer."*
* *"Rewrite my welcome message and A/B test it."*

<Callout>
  Most tools are **account-scoped** and need the account id in the form `acct_XXXXXXXXXXXXXXX`. If you omit it, Claude will ask — or it will call `list_accounts` first to find one.
</Callout>

## Troubleshooting

<Accordions type="single">
  <Accordion title="&#x22;Authentication failed&#x22; on the Authorize page">
    Your OnlyFans API session is invalid or expired. Sign in again at [app.onlyfansapi.com](https://app.onlyfansapi.com), then retry the **Connect** button on the connector.
  </Accordion>

  <Accordion title="Tool calls return 429 Too Many Requests">
    MCP calls are rate-limited to **120 requests/minute** per API key. Wait a minute and retry. If you hit this often, split work across multiple API keys.
  </Accordion>

  <Accordion title="Claude doesn't see the OnlyFans tools">
    The connector is toggled off in that conversation. Click **+** in the composer → **Connectors** → toggle **OnlyFans MCP** on.
  </Accordion>

  <Accordion title="Tool approval prompt keeps appearing">
    Click **Always allow** instead of approving once.
  </Accordion>
</Accordions>

## Plan notes

<Callout>
  **Claude Free** supports **1 custom connector** total. If you hit the limit, upgrade to Pro/Max/Team/Enterprise or remove an unused connector first.
</Callout>

## See also

* [OnlyFans MCP overview](/onlyfans-ai/mcp) — what MCP is, how it works, and supported clients
* [ChatGPT MCP install guide](/onlyfans-ai/mcp/chatgpt)
* [Manus MCP install guide](/onlyfans-ai/mcp/manus)
* [Develop with AI Agents](/introduction/guides/develop-with-ai-agents) — `llms.txt`, OpenAPI schema, `onlyfansapi-skill`
* [API Reference](/api-reference) — every endpoint exposed as an MCP tool
* [Connect OnlyFans account](/introduction/guides/connect-onlyfans-account) — prerequisite for account-scoped tool calls

# Embed in your app (/onlyfans-ai/mcp/embed)

## Who this is for

SaaS builders who already hold an OnlyFans API key and want to expose its tools to an LLM running inside their own product — chatbot, agent, copilot, batch worker, anything.

If you just want to chat with your OnlyFans accounts in Claude or ChatGPT, use the [Claude](/onlyfans-ai/mcp/claude) or [ChatGPT](/onlyfans-ai/mcp/chatgpt) install guides instead. This page is the **backend integration**, not the end-user setup.

## TL;DR

```
Authorization: Bearer ofapi_xxx_your_api_key
```

Pass your OnlyFans API key as a Bearer token to:

```
https://app.onlyfansapi.com/mcp/onlyfans-mcp
```

That is the entire authentication. There is no client registration, no callback URL, no PKCE, no token refresh.

<Callout>
  The OAuth 2.1 flow that the server also supports is only relevant when a third-party MCP client (Claude Desktop, ChatGPT, Cursor) needs to authorize on behalf of one of your end users in a browser. When your backend is the caller, you skip all of it.
</Callout>

## Prerequisites

1. An [OnlyFans API account](https://app.onlyfansapi.com).
2. An API key generated at [app.onlyfansapi.com/api-keys](https://app.onlyfansapi.com/api-keys). The key is scoped to the team it was created in — all MCP tool calls run as that team.
3. At least one [connected OnlyFans account](/introduction/guides/connect-onlyfans-account) (`acct_…`) on that team. Most tools require an `account` parameter to identify which account to act on.

<Callout type="warn">
  If your product is multi-tenant and each customer has their own OnlyFans API team, generate **one API key per customer team** and store it against your internal customer record. Do not share a single key across tenants.
</Callout>

## Anthropic Messages API

Anthropic's Messages API supports remote MCP servers directly. Pass the server URL and your OnlyFans API key as `authorization_token`.

```bash
curl https://api.anthropic.com/v1/messages \
  -H "x-api-key: $ANTHROPIC_API_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -H "content-type: application/json" \
  -d '{
    "model": "claude-opus-4-7",
    "max_tokens": 4096,
    "mcp_servers": [{
      "type": "url",
      "url": "https://app.onlyfansapi.com/mcp/onlyfans-mcp",
      "name": "onlyfans",
      "authorization_token": "ofapi_xxx_your_api_key"
    }],
    "messages": [
      { "role": "user", "content": "List the accounts on my team." }
    ]
  }'
```

The model sees the MCP tool list, decides which tools to call, and the Anthropic platform handles the JSON-RPC dance with our server. Tool calls and results are returned inline in the response.

Notes:

* `name` is a label that shows up in `tool_use` blocks. Pick something stable.
* `authorization_token` is sent to our server as `Authorization: Bearer {value}`. **Do not include the word `Bearer` in the value.**
* The MCP beta header may be required on some Anthropic accounts. Check Anthropic's current MCP connector documentation.

## OpenAI Responses API

OpenAI's Responses API exposes remote MCP servers as a tool of `type: "mcp"`.

```bash
curl https://api.openai.com/v1/responses \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "model": "gpt-5",
    "tools": [{
      "type": "mcp",
      "server_label": "onlyfans",
      "server_url": "https://app.onlyfansapi.com/mcp/onlyfans-mcp",
      "headers": {
        "Authorization": "Bearer ofapi_xxx_your_api_key"
      }
    }],
    "input": "List the accounts on my team."
  }'
```

<Callout>
  The exact field name for custom auth headers on OpenAI's MCP tool has shifted during the feature's rollout. Check OpenAI's current Responses API MCP reference before shipping. The semantics are identical: relay `Authorization: Bearer …` to our server on every tool call.
</Callout>

## Direct JSON-RPC

If you're running an agent loop yourself — without going through Anthropic or OpenAI's hosted tool execution — you can speak JSON-RPC to the MCP server directly. The transport is the standard MCP streamable HTTP.

```http
POST /mcp/onlyfans-mcp HTTP/1.1
Host: app.onlyfansapi.com
Authorization: Bearer ofapi_xxx_your_api_key
Accept: application/json, text/event-stream
Content-Type: application/json

{
  "jsonrpc": "2.0",
  "method": "initialize",
  "id": 1,
  "params": {
    "protocolVersion": "2025-06-18",
    "capabilities": {},
    "clientInfo": { "name": "your-product", "version": "1.0.0" }
  }
}
```

Standard MCP methods are available: `initialize`, `tools/list`, `tools/call`, `notifications/initialized`. Pagination is supported on `tools/list` with a default page size of 500 and a max of 1000.

## Per-request scoping

The API key fixes the **team**. Most tools additionally take an `account` parameter (format `acct_XXXXXXXXXXXXXXX`) to choose which connected OnlyFans account to act on.

The model will ask the user or call a discovery tool (e.g. `list_accounts`) to figure this out. If your product already knows which account the current chat is about, pin it in the system prompt:

```
Use account acct_XXXXXXXXXXXXXXX for all tool calls unless the user specifies otherwise.
```

## Tool surface

The MCP server auto-generates one tool per documented OnlyFans API endpoint. The full list is returned by `tools/list`. Annotations follow the MCP conventions:

* `GET` endpoints have `readOnlyHint: true`.
* `PUT` and `PATCH` endpoints have `idempotentHint: true`.
* `DELETE` endpoints have `destructiveHint: true`.

If your LLM context budget is tight, prune the tool surface client-side before sending it to the model. Anthropic's connector and OpenAI's Responses MCP tool both support filtering tools at the request level — check the platform documentation for the exact field name.

## Rate limits

| Route               | Limit               |
| ------------------- | ------------------- |
| `/mcp/onlyfans-mcp` | 120 requests/minute |

A single LLM turn may produce multiple tool calls, each of which is one MCP request. Budget accordingly when planning agentic loops.

## Errors

| Status                 | Meaning                                                                                                            | Fix                                                              |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------- |
| `401 invalid_token`    | Bearer token missing, malformed, or revoked.                                                                       | Check the `Authorization` header. Regenerate the key if rotated. |
| `401 token_not_pinned` | You're authenticating with an OAuth access token that has no team binding. Should not happen with a plain API key. | Use an API key, not an OAuth token, or re-authorize.             |
| `403`                  | Scope is fine but the requested resource belongs to a different team, or the account is not connected.             | Confirm `account` belongs to the key's team.                     |
| `429`                  | Rate limit.                                                                                                        | Back off, respect `Retry-After`.                                 |

<Callout type="warn">
  The `invalid_client` error that some teams hit when getting started is an **OAuth** error, not an API error. It means you're sending requests to `/oauth/token` with a `client_id` that does not exist. You do not need to call `/oauth/token` at all in this integration pattern. Talk only to `/mcp/onlyfans-mcp` and pass the API key directly.
</Callout>

## Security checklist

1. **Store API keys server-side only.** Never ship them to the browser, even for authenticated users.
2. **One API key per customer team.** Do not let tenant A's chatbot call tools that resolve against tenant B's accounts.
3. **Treat MCP tool calls like any other API call** from your product. Log them, rate-limit them per customer, and surface failures to the end user.
4. **Rotate keys when staff with access leaves.** There's no separate revoke per session — revocation is at the key level.
5. **Scope prompts so the LLM can't escalate** beyond the customer's own accounts (system prompt, allowed `account` IDs, etc.). The API enforces team isolation, but defense in depth is cheap.

## See also

* [OnlyFans MCP overview](/onlyfans-ai/mcp) — what MCP is, how it works, and supported clients
* [Claude MCP install guide](/onlyfans-ai/mcp/claude)
* [ChatGPT MCP install guide](/onlyfans-ai/mcp/chatgpt)
* [Manus MCP install guide](/onlyfans-ai/mcp/manus)
* [Develop with AI Agents](/introduction/guides/develop-with-ai-agents) — `llms.txt`, OpenAPI schema, `onlyfansapi-skill`
* [API Reference](/api-reference) — every endpoint exposed as an MCP tool

# Get Started with OnlyFans MCP (/onlyfans-ai/mcp)

import {
    SiClaude,
    SiClaudeHex,
} from "@icons-pack/react-simple-icons";
import { SiOpenai } from "react-icons/si";
import { PlugIcon, ServerIcon } from "lucide-react";
import { Step, Steps } from "fumadocs-ui/components/steps";

## What is the OnlyFans MCP server?

The OnlyFans MCP server exposes every OnlyFans API endpoint as a tool that any AI agent can call. Add it once to your AI tool of choice and your agent can read chats, fans, earnings, post content, run mass messages — without you writing any code.

It's built on the open [Model Context Protocol](https://modelcontextprotocol.io) standard, so the same server works with Claude, ChatGPT, Manus, Cursor, VS Code Copilot, and any custom agent.

<Callout>
  **5 years live · 0 bans.** Thousands of agencies run OnlyFans API in production today. Your AI agents ride on the same surface they do.
</Callout>

## MCP server URL

Same URL for every supported AI tool:

```
https://app.onlyfansapi.com/mcp/onlyfans-mcp
```

## Supported AI tools

<Cards>
  <Card icon={<SiClaude color={SiClaudeHex} />} href="/onlyfans-ai/mcp/claude" title="Claude">
    Claude Desktop, Claude.ai (web), Claude Code, and the Anthropic API. **60-second install.**
  </Card>

  <Card icon={<SiOpenai />} href="/onlyfans-ai/mcp/chatgpt" title="ChatGPT">
    Custom GPTs, Agent Mode, Deep Research. Requires Pro / Business / Enterprise. **90-second install.**
  </Card>

  <Card icon={<PlugIcon className="text-fd-primary" />} href="/onlyfans-ai/mcp/manus" title="Manus">
    Autonomous, scheduled agents — daily reports, churn rescue, whale watch. **90-second install.**
  </Card>

  <Card icon={<ServerIcon className="text-fd-primary" />} href="/introduction/guides/develop-with-ai-agents" title="Cursor / VS Code / custom agents">
    Built-in MCP support. Use `claude mcp add` or paste the URL into your MCP config.
  </Card>
</Cards>

## Prerequisites

Before you connect any AI tool:

* An [OnlyFans API account](https://app.onlyfansapi.com) — free to create, no credit card required
* An API key — generate one in your dashboard
* At least one [connected OnlyFans account](/introduction/guides/connect-onlyfans-account)

## How the install works (4 steps, \~60 seconds)

<Steps>
  <Step>
    **Sign up + grab an API key** in the [OnlyFans API dashboard](https://app.onlyfansapi.com).
  </Step>

  <Step>
    **Add the MCP server URL** to your AI client's connector panel.
  </Step>

  <Step>
    **Authorize via OAuth** — you'll be redirected to OnlyFans API to approve access.
  </Step>

  <Step>
    **Prompt your agent.** It now has 350+ tools across chats, fans, and earnings.
  </Step>
</Steps>

## Control & safety

Built for agencies, not hobbyists:

* **Scoped API keys** — restrict each key to specific endpoints. Read-only analyst agents and full-write ops agents in the same workspace.
* **Per-account permissions** — limit a key to one creator or a roster.
* **Audit log** — every API call your agent makes is logged. Review weekly.
* **No media stored** — photos, videos, and voice notes never live on our servers.
* **2FA on the dashboard** — mandatory for write-scoped keys.

<Callout type="warn">
  Use scoped, per-creator keys when handing access to autonomous agents. Audit weekly.
</Callout>

## Rate limits

MCP calls are rate-limited to **120 requests per minute** per API key. If you hit this often, split work across multiple keys.

## See also

* [Claude MCP install guide](/onlyfans-ai/mcp/claude)
* [ChatGPT MCP install guide](/onlyfans-ai/mcp/chatgpt)
* [Manus MCP install guide](/onlyfans-ai/mcp/manus)
* [Develop with AI Agents](/introduction/guides/develop-with-ai-agents) — `llms.txt`, OpenAPI schema, `onlyfansapi-skill`
* [API Reference](/api-reference) — every endpoint exposed as an MCP tool

# Manus x OnlyFans (/onlyfans-ai/mcp/manus)

import { Step, Steps } from "fumadocs-ui/components/steps";
import { Accordion, Accordions } from "fumadocs-ui/components/accordion";

<img alt="Manus × OnlyFans MCP" src={__img0} placeholder="blur" />

## What this does

Manus runs **autonomous, scheduled agents** on top of OnlyFans MCP. Wake up to a finished revenue digest, not a backlog. Drop in a recipe — daily digest, churn rescue, whale watch — or build your own Manus agent on top of 350+ tools.

Schedules and webhooks included. No code required.

<Callout>
  Manus is the right pick when you want work to **happen without you**. For interactive chat, use [Claude](/onlyfans-ai/mcp/claude) or [ChatGPT](/onlyfans-ai/mcp/chatgpt).
</Callout>

## Prerequisites

* An [OnlyFans API](https://app.onlyfansapi.com) account
* A **Manus workspace** with custom-MCP integration support
* At least one [connected OnlyFans account](/introduction/guides/connect-onlyfans-account)

## Step-by-step

Manus uses **streamable HTTP MCP**. The setup lives behind **Direct Configuration**.

### 1. Open the MCP configuration modal

In Manus, navigate:

**Settings** → **Connectors** → **Add Connector** → **Custom MCP** → **Add Custom MCP** → **Direct Configuration**

That opens the MCP configuration modal where you add a custom HTTP MCP.

### 2. Fill in the connector details

* **Transport Type** — `HTTP`
* **Server Name** — `OnlyFans MCP` (or any label you prefer)
* **Server URL**:

```
https://app.onlyfansapi.com/mcp/onlyfans-mcp
```

* **Note** *(optional)* — tell Manus when to use this MCP, e.g. *"Use for OnlyFans revenue, fans, and messaging tasks"*

### 3. Save

Click **Save**. Your agent can now call the 350+ tools exposed by the OnlyFans MCP server.

<Callout type="warn">
  Configure **approval queues** so write actions (mass-message, label updates, deletes) require a human OK. Read-only actions (earnings, fan lookups) can run unattended.
</Callout>

## Production-ready agent recipes

Drop these into Manus as scheduled agents. Each one runs end-to-end — no human, no chatter, no morning standup ritual. Adjust cadences and creator scopes to fit your roster.

### Daily revenue digest

**Schedule:** every day, 8am UTC

<Steps>
  <Step>
    Pull last-24h earnings + chargebacks across every connected creator.
  </Step>

  <Step>
    Group by creator, flag any drop >25% vs yesterday.
  </Step>

  <Step>
    Format as Slack-ready markdown.
  </Step>

  <Step>
    Post to `#ops-revenue`. No human approval required.
  </Step>
</Steps>

### Whale watch

**Schedule:** every 4 hours

<Steps>
  <Step>
    Scan new fans across the agency for spend > $200.
  </Step>

  <Step>
    Tag matches with the `vip` label via the OnlyFans API.
  </Step>

  <Step>
    Drop a message in `#ops-whales` with last message + last spend.
  </Step>

  <Step>
    Notify the assigned chatter directly.
  </Step>
</Steps>

### Churn rescue

**Schedule:** every Monday, 9am UTC

<Steps>
  <Step>
    Find subs lapsing in the next 7 days across every creator.
  </Step>

  <Step>
    Draft a personalised reactivation DM per fan. **Never auto-send.**
  </Step>

  <Step>
    Queue drafts in the ops chatter approval queue.
  </Step>

  <Step>
    Chatter reviews, edits, and ships in bulk.
  </Step>
</Steps>

## Example use cases

4 prompts to ship as scheduled Manus agents — overnight ops that pay back day one:

* *"Pull last 24h revenue and post to Slack at 8am every weekday."* — replaces a recurring n8n / Zapier workflow
* *"Find every fan whose subscription expires in 7 days and draft reactivation DMs."* — catches churn before it costs you the renewal
* *"Every 4h, label new whales (>$200 lifetime spend) and alert the assigned chatter."* — whales never slip through your dashboard
* *"Audit every creator nightly: chats with no reply >24h, list them in #ops-backlog."* — dropped chats never make it to morning standup

<Callout>
  Most tools are **account-scoped** and need the account id in the form `acct_XXXXXXXXXXXXXXX`. If you omit it, Manus will call `list_accounts` first to find one.
</Callout>

## Troubleshooting

<Accordions type="single">
  <Accordion title="Manus can't reach the MCP server">
    Confirm **Transport Type** is set to **HTTP** (not stdio) and the **Server URL** is exactly `https://app.onlyfansapi.com/mcp/onlyfans-mcp`. Then re-save the connector.
  </Accordion>

  <Accordion title="Tool calls return 429 Too Many Requests">
    MCP calls are rate-limited to **120 requests/minute** per API key. Wait a minute and retry. If you hit this often, split work across multiple API keys (one per scheduled agent).
  </Accordion>

  <Accordion title="My scheduled agent ran but did nothing">
    Check the agent's run log for an OAuth or `Authentication failed` error. Re-authorize the connector by signing in to [app.onlyfansapi.com](https://app.onlyfansapi.com) and reconnecting in Manus.
  </Accordion>

  <Accordion title="An agent did something I didn't approve">
    Lock down the connector with an approval queue for write actions. Use a **scoped, read-only API key** for analyst agents and reserve write-scoped keys for ops agents you actively supervise.
  </Accordion>
</Accordions>

## Compared to n8n / Zapier

|              | Manus                | [n8n](/integrations/n8n)     | [Zapier](/integrations/zapier) |
| ------------ | -------------------- | ---------------------------- | ------------------------------ |
| Best for     | Autonomous AI agents | Complex multi-step workflows | Trigger-based automations      |
| Skill needed | Plain English        | Light technical              | None                           |
| AI reasoning | Built-in             | Bring your own               | Limited                        |

Manus is the right pick when the work needs **judgement** — drafting DMs, ranking priorities, writing reports. Use n8n / Zapier when the work is purely **rule-based** — webhook in, action out.

## See also

* [OnlyFans MCP overview](/onlyfans-ai/mcp) — what MCP is, how it works, and supported clients
* [Claude MCP install guide](/onlyfans-ai/mcp/claude)
* [ChatGPT MCP install guide](/onlyfans-ai/mcp/chatgpt)
* [n8n integration](/integrations/n8n) — for rule-based automation
* [API Reference](/api-reference) — every endpoint exposed as an MCP tool

# Composing messages (/introduction/guides/composing-messages)

This guide will give you a brief overview of how to compose messages with various elements using our API.

<Callout type="warn">
  Please keep in mind that all of the below examples are meant to be sent as a `POST` request to our `https://app.onlyfansapi.com/api/{account}/chats/{chat_id}/messages` endpoint.

  **Looking for the `chat_id`? Use our [List Chats](/api-reference/chats/list-chats) endpoint.**
</Callout>

<Callout>
  **Looking for the developer-oriented documentation?** Please refer to our [API Reference](/api-reference/chat-messages/send-message).
</Callout>

## Text-only messages

Simply want to send a regular message? Use the following payload:

```json
{
  "text": "The text of your message"
}
```

## Adding media

Please refer to our dedicated guide on [uploading media](/introduction/guides/uploading-media) for more information on how to upload media files, and how to include them in your chat messages.

## Setting a price (PPV)

To set a price for your chat message, you can use the `price` field in your payload. This will make your message paid (PPV). **All paid messages must contain at least one media file.**

### Only including paid media

To send a paid message without any free preview media, you can use the following payload:

```json
{
  "text": "The text of your message",
  "mediaFiles": ["ofapi_media_123", 3866342509],
  "price": 5
}
```

<Callout>
  The `mediaFiles` parameter can contain either `ofapi_media` IDs, or OnlyFans Vault Media ID (e.g., `3866342509`). You can find more information about these IDs in our [media uploads guide](/introduction/guides/uploading-media). **You can mix-and-match these IDs in the same array.**
</Callout>

### Including free preview media

To send a paid message with free preview media, you can use the `previews` field in your payload. This allows you to include media that will be visible to the recipient, even if they haven't paid for the message.

<Callout>
  **Important!**\
  Make sure to list every `previews` media file in the `mediaFiles` array as well. Otherwise, the API will return an error.

  The `previews` array is only used to indicate which media files are free, while the `mediaFiles` array contains all media files included in the message, regardless of whether they are paid or free.
</Callout>

```json
{
  "text": "The text of your message",
  "mediaFiles": ["ofapi_media_123", 3866342509],
  "previews": ["ofapi_media_456", 1234567890],
  "price": 5
}
```

<Callout>
  The `mediaFiles` and `previews` parameters can contain either `ofapi_media` IDs, or OnlyFans Vault Media ID (e.g., `3866342509`). You can find more information about these IDs in our [media uploads guide](/introduction/guides/uploading-media). **You can mix-and-match these IDs in the same array.**
</Callout>

## Tagging other OnlyFans creators

To tag other OnlyFans creators in your message, you can use the `rfTag` field in your payload. You can specify multiple creators by providing an array of their OnlyFans user IDs.

```json
{
  "text": "The text of your message",
  "rfTag": [123, 456]
}
```

<Callout>
  **How to find the OnlyFans user ID of a creator?**

  * **If you've connected the relevant creator account to OnlyFans API**, you can use our [List Accounts](/api-reference/account/list-accounts) endpoint.
  * **Not connected, but you know the creator's username?** You can use our [Get Profile Details](/api-reference/public-profiles/get-profile-details) endpoint.
  * **Not connected and don't know the username?** You can use our [Search Profiles](/api-reference/public-profiles/search-profiles) endpoint.
</Callout>

## Formatting your message text

Please refer to our dedicated guide on [text formatting](/introduction/guides/text-formatting) for more information on how to format your message text, including text styles, colors, and more.

# Composing posts (/introduction/guides/composing-posts)

This guide will give you a brief overview of how to compose posts with various elements using our API.

<Callout type="warn">
  Please keep in mind that all of the below examples are meant to be sent as a `POST` request to our `https://app.onlyfansapi.com/api/{account}/posts` endpoint.
</Callout>

<Callout>
  **Looking for the developer-oriented documentation?** Please refer to our [API Reference](/api-reference/posts/send-post).
</Callout>

## Text-only posts

Simply want to send a regular text post? Use the following payload:

```json
{
  "text": "The text of your post"
}
```

## Post labels

### Retrieving the account's existing labels

<Callout>
  **Looking for the developer-oriented documentation?** Please refer to our [API Reference](/api-reference/post-labels/list-labels).
</Callout>

You can retrieve the account's existing labels by sending a `GET` request to the `https://app.onlyfansapi.com/api/{account}/posts/labels` endpoint.

It will return a payload like:

```json
[
  {
    "id": "archived",
    "name": "Archive",
    "type": "archived",
    "isClearInProgress": false,
    "postsCount": 0,
    "posts": []
  },
  {
    "id": "private_archived",
    "name": "Private Archive",
    "type": "private_archived",
    "isClearInProgress": false,
    "postsCount": 0,
    "posts": []
  },
  {
    "id": 123,
    "name": "My new label",
    "type": "custom",
    "isClearInProgress": false,
    "postsCount": 123,
    "posts": []
  }
]
```

You can then use the `id` of the label(s) to apply it to your post.

### Creating a new label

<Callout>
  **Looking for the developer-oriented documentation?** Please refer to our [API Reference](/api-reference/post-labels/create-label).
</Callout>

To create a new label, send a `POST` request to the `https://app.onlyfansapi.com/api/{account}/posts/labels` endpoint with the following payload:

```json
{
  "name": "My new label"
}
```

It will then return a payload like:

```json
{
  "data": {
    "id": 123,
    "name": "My new label",
    "type": "custom",
    "isClearInProgress": false,
    "postsCount": 0,
    "posts": []
  }
}
```

You can then use the `id` of the newly created label to apply it to your post.

### Adding label(s) to your post

To add label(s) to your post, you can use the `labels` field in your payload. You can specify multiple labels by providing an array of label IDs.

```json
{
  "text": "The text of your post",
  "labelIds": [123, 456]
}
```

## Adding media

Please refer to our dedicated guide on [uploading media](/introduction/guides/uploading-media) for more information on how to upload media files, and how to include them in your posts.

## Adding polls

Both regular polls and quizzes are supported in our API. You can choose which type of poll to include in your post by setting the `votingType` field in your payload to either `poll` or `quiz`.

### Regular polls

To include a regular poll in your post, set the `votingType` field to `poll`.

**Specifying the options**\
The poll's options can be set by using the `votingOptions` field. It should be an array of strings. **You must provide at least 2 options.**

**Setting a due date** (optional)\
You can set a due date by using the `votingDue` field, which specifies the number of days until the poll expires. Valid values are **1**, **3**, **7**, or **30** days. If not specified, the poll will never expire.

```json
{
  "text": "The text of your post",
  "votingType": "poll",
  "votingOptions": ["Option 1", "Option 2"],
  "votingDue": 7
}
```

### Quizzes

To include a quiz in your post, set the `votingType` field to `quiz`.

**Specifying the options**\
The quiz options can be set by using the `votingOptions` field. It should be an array of strings. **You must provide at least 2 options.**

**Specifying the correct answer**\
Specify the correct answer by using the `votingCorrectIndex` field. It should be an integer representing the index of the correct answer in the `votingOptions` array (starting from 0). For example, if the correct answer is the first option, set it to `0`.

**Setting a due date** (optional)\
You can set a due date by using the `votingDue` field, which specifies the number of days until the quiz expires. Valid values are **1**, **3**, **7**, or **30** days. If not specified, the quiz will never expire.

```json
{
  "text": "The text of your post",
  "votingType": "quiz",
  "votingOptions": ["Option 1", "Option 2"],
  "votingCorrectIndex": 0,
  "votingDue": 7
}
```

## Setting an expiration date

To set an expiration date for your post, you can use the `expireDays` field in your payload. The value must be **1**, **3**, **7** or **30** days.

```json
{
  "text": "The text of your post",
  "expireDays": 7
}
```

## Scheduling posts

To schedule your post, you can use the `scheduledDate` field in your payload. The value must be a valid date-time string formatted as `2025-06-03T15:30:00.000Z` (ISO 8601 format) in UTC timezone.

```json
{
  "text": "The text of your post",
  "scheduledDate": "2023-10-01T12:00:00Z"
}
```

## Saving a post for later

To save a post for later, you can use the `saveForLater` field in your payload. Set it to `true` to save the post without publishing it immediately. You can then find your post here: [https://onlyfans.com/saved-for-later-posts](https://onlyfans.com/saved-for-later-posts)

```json
{
  "text": "The text of your post",
  "saveForLater": true
}
```

## Setting a fundraising target

To include a fundraising target in your post, you can use the `fundRaisingTargetAmount` and `fundRaisingTipsPresets` fields in your payload.

**Setting a target amount**\
The `fundRaisingTargetAmount` field specifies the target amount for your fundraising post. It must be a at least `10` representing the amount in your account's currency.

**Setting tip presets**\
The `fundRaisingTipsPresets` field allows you to specify the preset tip amounts that users can choose from. It should be an array of integers representing the amounts in your account's currency.

**Tip preset rules**

* You must provide at least one preset value.
* Each preset value must be at least `5`.
* Each preset value may not be more than the `fundRaisingTargetAmount`.

```json
{
  "text": "The text of your post",
  "fundRaisingTargetAmount": 30,
  "fundRaisingTipsPresets": [5, 10, 15]
}
```

## Tagging other OnlyFans creators

To tag other OnlyFans creators in your post, you can use the `rfTag` field in your payload. You can specify multiple creators by providing an array of their OnlyFans user IDs.

```json
{
  "text": "The text of your post",
  "rfTag": [123, 456]
}
```

<Callout>
  **How to find the OnlyFans user ID of a creator?**

  * **If you've connected the relevant creator account to OnlyFans API**, you can use our [List Accounts](/api-reference/account/list-accounts) endpoint.
  * **Not connected, but you know the creator's username?** You can use our [Get Profile Details](/api-reference/public-profiles/get-profile-details) endpoint.
  * **Not connected and don't know the username?** You can use our [Search Profiles](/api-reference/public-profiles/search-profiles) endpoint.
</Callout>

## Formatting your post text

Please refer to our dedicated guide on [text formatting](/introduction/guides/text-formatting) for more information on how to format your post text, including text styles, colors, and more.

# Connect OnlyFans account (/introduction/guides/connect-onlyfans-account)

import { Accordion, Accordions } from "fumadocs-ui/components/accordion";

## Why do you need to connect your OnlyFans account?

If you want to use our API to interact with OnlyFans API endpoints like:

* Reading chats
* Sending messages to fans
* Getting statistics
* Getting fans
* Following / unfollowing users
* Getting webhook notifications
* ... basically anything that requires you to be logged in to your OnlyFans account.

Then, you need to connect your OnlyFans account to our API.

You can connect your OnlyFans account in five ways:

1. Using our automated login flow (recommended for most users)
2. Using our **Auth+** iPhone app (recommended when 2FA tokens aren't available to you, or when Face ID is enabled)
3. Add "Login with OnlyFans" to your app
4. Connect using API (programmatic flow)
5. By providing cURL request

<Callout>
  **Which option should you pick?**
  If you (the OFAPI user — e.g. an agency) have easy access to the OnlyFans account's credentials and 2FA tokens, use **Option 1** (automated login flow).
  If you don't have direct access to the creator's 2FA tokens, or the creator's OnlyFans account has **Face ID verification** enabled, use **Option 2** (Auth+ app) — the creator completes sign-in and 2FA on their own iPhone.
</Callout>

<Accordions type="single">
  <Accordion title="Decision flowchart — which option should I pick?">
    <Mermaid
      chart="flowchart TD
    Start([Which auth option should I use?]) --> Q1{Creator has 2FA or<br/>Face Authentication enabled?}
    Q1 -->|No| A1[Dashboard or API]
    Q1 -->|SMS / Authenticator OTP| Q2{Do you have easy access<br/>to these codes?}
    Q1 -->|Face Authentication| Q3{Which Face Authentication<br/>version?}
    Q2 -->|Yes| A2[Dashboard or API]
    Q2 -->|No| A3[Auth+ app]
    Q3 -->|v1| A4[Dashboard, API,<br/>or Auth+ app]
    Q3 -->|v2 — Dashboard/API sessions fail| A5[Auth+ app required]"
    />
  </Accordion>
</Accordions>

### Option 1: Using our automated login flow

This is the recommended flow when you already have the OnlyFans credentials and can enter the 2FA code on behalf of the creator.
Our system can bypass captcha and if you've setup 2FA, you'll be able to enter the 2FA code directly inside our interface while we sign in your profile.

<Callout>
  Your credentials are securely stored in our database and are never shared with
  anyone (not even our engineers can see your credentials).
</Callout>

Steps to connect your OnlyFans account:

1. Go to the [OnlyFans API Console -> Accounts](https://app.onlyfansapi.com/accounts)
2. Click on the **+ Connect Account** button
3. Enter name of the account (this will be used for your reference)
4. Enter your OnlyFans email and password
5. Choose Proxy Country — currently **US** and **UK** are available (we will automatically assign a dedicated mobile IP address for this account), or enter your own proxy details

<Callout type="warn">
  Other proxy countries (DE, FR, IT) have been temporarily removed due to OnlyFans restrictions.
</Callout>

6. Click on the **Add** button
7. Your account will start connecting and you'll see the live progress of the login process.
8. **If you've 2FA enabled on your OnlyFans account**, you'll be asked to enter the 2FA code.
   <img alt="OnlyFans API Console - Connect Account - Enter 2FA code" src={__img0} placeholder="blur" />
9. Done! ✅ You're now able to see the account details and start using your account with our API.

### Option 2: Using our Auth+ iPhone app

<Callout>
  **When to use Auth+:** pick this option only if you (the OFAPI user) don't have easy access to the OnlyFans account's 2FA tokens, or if the creator's OnlyFans account has **Face ID verification** enabled. Otherwise, Option 1 is simpler.
</Callout>

<Callout title="📱 Install the Auth+ app first">
  Before starting a session, the creator should install the **FansAPI Auth+** app on their iPhone via TestFlight:
  [**app.onlyfansapi.com/auth-plus-app**](https://app.onlyfansapi.com/auth-plus-app)

  If they don't already have TestFlight, install it from the App Store first: [**Get TestFlight**](https://itunes.apple.com/us/app/testflight/id899247664?mt=8). The phone-only video below also walks through this.
</Callout>

Auth+ is our iPhone app that lets creators sign in to their OnlyFans account directly from their device. It handles every 2FA method OnlyFans supports — App/SMS OTP as well as Face ID verification — without the creator leaving their phone.

You can start an Auth+ session in two ways: from the [OnlyFans API Console](https://app.onlyfansapi.com/accounts) (creator scans a QR code), or programmatically via the API (creator pastes an auth code).

#### Video guides

Follow one of the two walkthroughs below depending on your setup.

**Desktop + phone flow**

<iframe width="100%" height="400px" src="https://www.youtube.com/embed/M8t57Ck9SuU" title="Auth+ — desktop + phone walkthrough" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen className="rounded-md" />

**Phone-only flow (includes TestFlight install)**

<iframe width="100%" height="400px" src="https://www.youtube.com/embed/4eDh_qAFYMA" title="Auth+ — phone-only walkthrough" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen className="rounded-md" />

#### Step 1a — Start the session from the Dashboard

1. Go to the [OnlyFans API Console -> Accounts](https://app.onlyfansapi.com/accounts)
2. Click on the **+ Connect Account** button
3. Enter the name of the account (this will be used for your reference)
4. Click on **Auth+**
5. Click on the **Add** button

You'll be shown a QR code and an auth code — hand either to the creator for the next step.

#### Step 1b — Or start the session via the API

Call [`POST /authenticate`](/api-reference/connect-onlyfans-account/start-authentication) with `auth_type` set to `mobile_app` and a `display_name` for the account:

```bash
curl --request POST \
  --url 'https://app.onlyfansapi.com/api/authenticate' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "auth_type": "mobile_app",
    "display_name": "My Application / Model: John Doe"
  }'
```

Example response:

```json
{
  "attempt_id": "auth_abc123",
  "message": "Authentication process started. Query the polling_url to check the progress.",
  "polling_url": "https://app.onlyfansapi.com/api/authenticate/auth_abc123",
  "mobile_auth_session_deeplink": "fansapiauth://auth/fansapi_auth_abc123"
}
```

The `mobile_auth_session_deeplink` opens the Auth+ app directly on the creator's iPhone with the session pre-filled. You can also hand them the auth code (`fansapi_auth_abc123`) to paste manually into the app.

#### Step 2 — Complete the sign-in on the creator's iPhone

These steps are the same whether the session was started from the Dashboard or the API.

1. Install **TestFlight** from the App Store
2. Install the **FansAPI Auth+** app via TestFlight: [app.onlyfansapi.com/auth-plus-app](https://app.onlyfansapi.com/auth-plus-app)
3. Open Auth+ and either **scan the QR code** (Dashboard flow) or **paste the auth code** (Dashboard or API flow)
4. Sign in with the OnlyFans email and password
5. Complete any 2FA step (App/SMS OTP or Face Authentication) directly inside the app

Done! ✅ The account is now connected and ready to use with our API.

### Option 3: Add "Login with OnlyFans" to your app

If you want to embed a "Connect with OnlyFans" flow directly in your app UI, use the official auth package.

#### 1) Install package

```bash
npm install @onlyfansapi/auth
```

#### 2) Create a client session token

Create a client session token (`ofapi_cs_...`) from your backend:

`POST /client-sessions`

```bash
curl --request POST \
  --url 'https://app.onlyfansapi.com/api/client-sessions' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "display_name": "My Application / Model: John Doe",
    "client_reference_id": "my-internal-id-123",
    "proxy_country": "us"
  }'
```

#### 3) Start authentication in your frontend

```ts
import { startOnlyFansAuthentication } from "@onlyfansapi/auth";

startOnlyFansAuthentication("ofapi_cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", {
  onSuccess: (data) => {
    // data.accountId
    // data.username
    // data.response (full response)
    console.log("Connected:", data);
  },
  onError: (error) => {
    // error.message
    // error.code (if available)
    // error.details (if available)
    console.error("Authentication failed:", error);
  },
});
```

<Callout>
  This package handles the OTP / selfie authentication UI flow for you in an embedded modal.
</Callout>

<Callout>
  For the full authentication API and package reference, see: [`/auth`](/auth).
</Callout>

### Option 4: Connect using API (programmatic flow)

Use this flow if you want to connect accounts from your backend or app UI instead of the dashboard.

<Callout>
  Base URL for examples below: <code>[https://app.onlyfansapi.com/api](https://app.onlyfansapi.com/api)</code>
</Callout>

#### 1) Start authentication

`POST /authenticate`

```bash
curl --request POST \
  --url 'https://app.onlyfansapi.com/api/authenticate' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "model@example.com",
    "password": "super-secret-password",
    "proxyCountry": "us"
  }'
```

Example response:

```json
{
  "attempt_id": "auth_xxxxxxxxxxxxx",
  "message": "Authentication process started. Query the polling_url to check the progress.",
  "polling_url": "https://app.onlyfansapi.com/api/authenticate/auth_xxxxxxxxxxxxx"
}
```

#### 2) Poll status until completion or 2FA required

`GET /authenticate/{attempt_id}`

```bash
curl --request GET \
  --url 'https://app.onlyfansapi.com/api/authenticate/auth_xxxxxxxxxxxxx' \
  --header 'Authorization: Bearer YOUR_API_KEY'
```

Important fields:

* `state`
* `progress`
* `lastAttempt.success`
* `lastAttempt.needs_otp`
* `lastAttempt.needs_face_otp`
* `lastAttempt.face_otp_verification_url`
* `lastAttempt.error_message`
* `lastAttempt.error_code`

When `lastAttempt.needs_face_otp` is `true`, use `lastAttempt.face_otp_verification_url`.
That URL is the OnlyFans selfie verification page that the creator must open and complete.

#### 3) Submit 2FA code (SMS or OTP app)

`PUT /authenticate/{attempt_id}`

```bash
curl --request PUT \
  --url 'https://app.onlyfansapi.com/api/authenticate/auth_xxxxxxxxxxxxx' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "code": "123456"
  }'
```

If selfie verification is required, submit:

```json
{
  "selfie_verification_completed": true
}
```

<Callout>
  For the standard (v1) selfie verification, no external mobile app is required. The creator only needs to open
  the <code>face\_otp\_verification\_url</code> link in a regular browser on their phone or desktop
  and complete the verification steps there. Alternatively, they can complete it through our [**Auth+ app**](#option-2-using-our-auth-iphone-app).
</Callout>

<Callout type="warn" title="v2 Face Authentication requires Auth+">
  If the creator's OnlyFans account has OnlyFans' **v2 Face Authentication** system enabled, the Dashboard and API flows (without Auth+) **CANNOT** complete sign-in.
  You **MUST** use our [**Auth+ iPhone app**](#option-2-using-our-auth-iphone-app) — it's the only flow that supports v2 Face Authentication.
</Callout>

#### 4) Optional: send OTP verification email to creator

`POST /authenticate/{attempt_id}/send-email-to-creator`

```bash
curl --request POST \
  --url 'https://app.onlyfansapi.com/api/authenticate/auth_xxxxxxxxxxxxx/send-email-to-creator' \
  --header 'Authorization: Bearer YOUR_API_KEY'
```

#### Handling failed 2FA and retry

##### Wrong code retry (phone/app OTP)

If the submitted OTP is invalid, the attempt enters retry mode instead of failing permanently.

* Retry progress: `wrong_2fa_code_retry`
* Definitive error code: `WRONG_2FA`
* Re-submit a fresh code via `PUT /authenticate/{attempt_id}` (no restart needed)

Example poll response while retry is available:

```json
{
  "state": "needs-app-otp",
  "progress": "wrong_2fa_code_retry",
  "lastAttempt": {
    "success": false,
    "error_message": null,
    "error_code": "WRONG_2FA",
    "needs_otp": true,
    "needs_face_otp": false
  }
}
```

##### Other 2FA failure cases

* `lastAttempt.error_message` is populated for terminal failures (for example timeout or upstream verification errors).
* If you submit OTP when none is pending, API returns `400` with: `No pending OTP verification`.
* Recommended behavior:
  1. Keep polling while `completed_at` is `null`.
  2. If `lastAttempt.needs_face_otp` is `true`, take `lastAttempt.face_otp_verification_url`, ask the creator to complete selfie verification in browser, then submit:
     ```json
     { "selfie_verification_completed": true }
     ```
  3. If `state` is `needs-otp` (phone OTP), prompt for SMS code and submit:
     ```json
     { "code": "12345" }
     ```
  4. If `state` is `needs-app-otp` (authenticator app), prompt for app code and submit:
     ```json
     { "code": "123456" }
     ```
  5. If `progress` is `wrong_2fa_code_retry`, prompt user for a new OTP and re-submit.
  6. If attempt is completed with failure, show `error_message` and start a new authentication attempt.

### Option 5: By providing cURL request

This is the manual way to connect your OnlyFans account to our API.

<Callout type="warn">
  We recommend to sign in and enter the cURL request from a **incognito
  window**. Please do NOT sign out account after you've connected it to our API,
  just close the incognito window.
</Callout>

Honestly, it's easier to watch the video below and follow the steps.

<iframe width="100%" height="400px" src="https://www.youtube.com/embed/6fijw-Y6qis" title="" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen className="rounded-md" />

## What does "Face OTP request attempts exhausted" mean?

When you connect an OnlyFans account that requires **Face ID Authentication**, you may run into the message **"Face OTP request attempts exhausted"**. This happens because OnlyFans enforces a **daily limit of 3 Face ID requests per day** on the account.

### How attempts get used up

Every time the account is added to OnlyFans API, **one Face ID attempt is used**. We start a Face ID request by default when it's the only enabled 2FA method, so the attempt is consumed **even if the Face ID verification was only started but never completed** — a started-but-incomplete attempt still counts against the daily limit of 3.

### How the limit resets

There are only two ways to reset the limit:

1. **Complete Face ID** before the attempts are exhausted, or
2. **Wait 24 hours** after exhaustion — the counter will then reset itself back to 3.

<Callout type="warn">
  There is **no way around** Face ID attempt exhaustion. Once the 3 daily attempts are used up, you **always** have to wait 24 hours for the limit to reset. This is an OnlyFans-side restriction — neither you nor we can do anything to bypass or speed it up.
</Callout>

# Connect CreatorTraffic to OnlyFans API Smart Links (/introduction/guides/creatortraffic-smart-links)

import { Step, Steps } from "fumadocs-ui/components/steps";

## What the CreatorTraffic integration does

CreatorTraffic is a traffic source for OnlyFans media buyers. This integration connects your CreatorTraffic ad account to OnlyFans API **Smart Links** so that every new subscriber you generate is reported straight back to CreatorTraffic for attribution.

**Why connect it?** Once connected, OnlyFans API postbacks each subscriber conversion to CreatorTraffic **server-side**, matched to the click that drove it. You get a clear view of which CreatorTraffic campaigns actually generate subscribers, instead of optimizing blind on clicks. No JavaScript, nothing to install on OnlyFans, and only a single API token to set up.

## Watch the walkthrough

<iframe className="aspect-video w-full" src="https://www.youtube.com/embed/4hhq2JGdS-w" title="CreatorTraffic × OnlyFans API Smart Links integration walkthrough" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerPolicy="strict-origin-when-cross-origin" allowFullScreen />

## Step-by-step setup

<Steps>
  <Step>
    ### Open your CreatorTraffic settings

    Go to [ads.creatortraffic.com/settings](https://ads.creatortraffic.com/settings) and choose **Settings** from the sidebar.

        <img alt="CreatorTraffic settings menu" src={__img0} placeholder="blur" />
  </Step>

  <Step>
    ### Generate and copy your API token

    In **API Access**, click **Generate API Token**, then copy the token.

        <img alt="CreatorTraffic API token field" src={__img1} placeholder="blur" />

    <Callout type="warn">
      If the **Generate API Token** button is unavailable, ask your CreatorTraffic account manager to enable API access on your account.
    </Callout>
  </Step>

  <Step>
    ### Connect it in OnlyFans API

    Log into your [OnlyFans API Dashboard](https://app.onlyfansapi.com), open **Smart Links → Ad Platforms**, click **Add Platform**, and select **CreatorTraffic**. Paste the token into the **API Token** field and click **Create**.

    <div className="mx-auto max-w-md">
            <img alt="OnlyFans API dashboard: CreatorTraffic API Token field" src={__img2} placeholder="blur" />
    </div>
  </Step>

  <Step>
    ### Add the click ID to your Smart Link URL

    Copy your Smart Link and append CreatorTraffic's click-ID parameters to the ad's destination URL so each conversion can be matched back to the click that drove it:

    ```text
    https://trk.of-traffic.com/go/YOUR_SMART_LINK_ID?ecid={clickid}&utm_source=creatortraffic
    ```

    Replace `YOUR_SMART_LINK_ID` with the ID from your Smart Links dashboard. CreatorTraffic replaces `{clickid}` with the click's ID at click time, and Smart Links reads it from the `ecid` parameter and sends it back to CreatorTraffic with every conversion. Keep both `?ecid={clickid}` and `&utm_source=creatortraffic` on the URL.

        <img alt="CreatorTraffic ad destination URL with click ID parameters" src={__img3} placeholder="blur" />
  </Step>

  <Step>
    ### You're done

    New subscribers attributed to that Smart Link are now postbacked to CreatorTraffic using the click ID. They'll show up against the matching campaign in your CreatorTraffic reports.
  </Step>
</Steps>

# Develop with AI Agents (/introduction/guides/develop-with-ai-agents)

import {
    BookOpenTextIcon,
    PlugZapIcon,
    BoxIcon,
    LightbulbIcon,
} from 'lucide-react';

import {
    SiModelcontextprotocol,
} from "@icons-pack/react-simple-icons";

## Not sure where to start? \[!toc]

<Cards>
  <Card icon={<BookOpenTextIcon className="text-fd-primary" />} title="AI-ready docs resources" href="#ai-ready-docs-resources">
    `llms.txt`, `llms-full.txt`, per-page `.mdx` URLs, and the OpenAPI schema.
  </Card>

  <Card icon={<PlugZapIcon className="text-fd-primary" />} icon={<SiModelcontextprotocol className="text-fd-primary" />} title="Connect our docs via MCP" href="#connect-our-docs-via-mcp">
    One-click install for Cursor, VS Code, Claude, ChatGPT, and any other MCP client.
  </Card>

  <Card icon={<BoxIcon className="text-fd-primary" />} title="Install onlyfansapi-skill" href="#install-onlyfansapi-skill-from-skillssh">
    Drop-in skill from skills.sh that teaches your agent the API surface.
  </Card>

  <Card icon={<LightbulbIcon className="text-fd-primary" />} title="Prompting tips" href="#prompting-tips-for-better-agent-output">
    Small prompt tweaks that produce dramatically better agent output.
  </Card>
</Cards>

## AI-ready docs resources

When building with AI agents, point them to these resources first:

* [docs.onlyfansapi.com/llms.txt](https://docs.onlyfansapi.com/llms.txt) - canonical AI-friendly docs entrypoint
* [docs.onlyfansapi.com/llms-full.txt](https://docs.onlyfansapi.com/llms-full.txt) - complete LLM-friendly docs (also used for backward compatibility)
* [API Reference](/api-reference) - interactive endpoint docs by category
* [OpenAPI schema](https://app.onlyfansapi.com/scribe-docs/openapi.yaml) - machine-readable API spec

### Per-page `.mdx` URLs

For individual guides or API endpoints, just append `.mdx` to the page URL and feed that directly to the AI agent.

Examples:

* `https://docs.onlyfansapi.com/introduction/guides/develop-with-ai-agents.mdx`
* `https://docs.onlyfansapi.com/api-reference/account/list-accounts.mdx`
* `https://docs.onlyfansapi.com/api-reference/chats/list-chats.mdx`

## Connect our docs via MCP

We host a remote [Model Context Protocol](https://modelcontextprotocol.io) server at:

```
https://docs.onlyfansapi.com/api/mcp
```

Hook it into Claude, Cursor, VS Code, ChatGPT, or any other MCP-compatible client and your agent gets three tools that query these docs directly — no copy/paste, always up to date:

* `search_docs(query, limit?)` — full-text search across the docs (Algolia).
* `get_doc_page(path)` — raw Markdown for a single page (path or full URL).
* `get_overview()` — the entire docs as one Markdown document ([`llms.txt`](https://docs.onlyfansapi.com/llms.txt)).

<Callout>
  The MCP server is public, read-only, and requires no API key. It only exposes content already published at [docs.onlyfansapi.com](https://docs.onlyfansapi.com).
</Callout>

### Cursor

[**→ Add to Cursor (one click)**](cursor://anysphere.cursor-deeplink/mcp/install?name=onlyfansapi-docs\&config=eyJ1cmwiOiJodHRwczovL2RvY3Mub25seWZhbnNhcGkuY29tL2FwaS9tY3AifQ==)

Or manually: **Settings** → **MCP** → **Add new server**, type **HTTP**, URL `https://docs.onlyfansapi.com/api/mcp`.

### VS Code (GitHub Copilot)

[**→ Add to VS Code (one click)**](vscode:mcp/install?%7B%22name%22%3A%22onlyfansapi-docs%22%2C%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fdocs.onlyfansapi.com%2Fapi%2Fmcp%22%7D)

Or manually: open the Command Palette → **MCP: Add Server** → **HTTP** → URL `https://docs.onlyfansapi.com/api/mcp`.

### Claude Desktop

Open **Settings** → **Connectors** → **Add custom connector** and paste the URL:

```
https://docs.onlyfansapi.com/api/mcp
```

Alternatively, add this entry to `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows) and restart the app:

```json
{
  "mcpServers": {
    "onlyfansapi-docs": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://docs.onlyfansapi.com/api/mcp"]
    }
  }
}
```

### Claude.ai (web)

In Claude.ai: **Settings** → **Connectors** → **Add custom connector** → URL `https://docs.onlyfansapi.com/api/mcp`. Requires a paid plan that supports custom connectors.

### ChatGPT

In ChatGPT: **Settings** → **Connectors** → **Create** → paste `https://docs.onlyfansapi.com/api/mcp`. Custom connectors are available on plans that include MCP support (Pro / Business / Enterprise at the time of writing).

### Other MCP clients

Any client that speaks Streamable HTTP MCP works — point it at `https://docs.onlyfansapi.com/api/mcp`. For stdio-only clients, bridge with [`mcp-remote`](https://www.npmjs.com/package/mcp-remote):

```bash
npx -y mcp-remote https://docs.onlyfansapi.com/api/mcp
```

## Install `onlyfansapi-skill` from skills.sh

Skill page:
[skills.sh/onlyfansapi/skill/onlyfansapi-skill](https://skills.sh/onlyfansapi/skill/onlyfansapi-skill)

Install command shown on the skill page:

```bash
npx skills add https://github.com/onlyfansapi/skill --skill onlyfansapi-skill
```

<Callout>
  Restart your agent/CLI session after installation so the new skill is loaded.
</Callout>

### Configure your API key

The skill expects `ONLYFANSAPI_API_KEY` in your environment:

```bash
export ONLYFANSAPI_API_KEY="your_api_key_here"
```

Get your key from:
[app.onlyfansapi.com/api-keys](https://app.onlyfansapi.com/api-keys)

Quick auth check:

```bash
curl -s -H "Authorization: Bearer $ONLYFANSAPI_API_KEY" \
  "https://app.onlyfansapi.com/api/accounts" | jq .
```

## Prompting tips for better agent output

* Ask the agent to read `llms.txt` or `llms-full.txt` before generating calls.
* Include exact date ranges and timezone when requesting analytics.
* Ask for tables with totals when comparing multiple accounts.
* Ask the agent to show endpoint path + params before execution if you want to review requests first.

# Downloading Media from OnlyFans CDN (/introduction/guides/downloading-media)

OnlyFans API makes it easy to download media files directly from OnlyFans CDN URLs. You can download photos, videos, and audio files by calling our download endpoint with the CDN URL.

## Download media from OnlyFans CDN

<Callout>
  The full media download endpoint documentation can be found
  [here](/api-reference/media/download-media-from-the-only-fans-cdn).
</Callout>

Media can be downloaded by calling GET `https://app.onlyfansapi.com/api/{account}/media/download/{ONLYFANS_CDN_URL}`.

The `{ONLYFANS_CDN_URL}` parameter should be a URL from any OnlyFans CDN subdomain (i.e. anything matching `https://cdn*.onlyfans.com/*`, such as `cdn2.onlyfans.com`, `cdn3.onlyfans.com`, etc.). A typical URL looks like `https://cdn2.onlyfans.com/files/e/e5/123/600x400_123.jpg?Tag=2&u=123&Policy=123&Signature=signature&Key-Pair-Id=123`. You can just enter the OnlyFans CDN URL after the `.../media/download/{ONLYFANS_CDN_URL}` without any need for encoding the URL.

<CodeBlockTabs defaultValue="cURL">
  <CodeBlockTabsList>
    <CodeBlockTabsTrigger value="cURL">
      cURL
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="JavaScript (Fetch)">
      JavaScript (Fetch)
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="Node.js (Axios)">
      Node.js (Axios)
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="PHP (Guzzle)">
      PHP (Guzzle)
    </CodeBlockTabsTrigger>
  </CodeBlockTabsList>

  <CodeBlockTab value="cURL">
    ```bash
    curl --location 'https://app.onlyfansapi.com/api/{account}/media/download/https://cdn2.onlyfans.com/files/e/e5/123/600x400_123.jpg?Tag=2&u=123&Policy=123&Signature=signature&Key-Pair-Id=123' \
         --header 'Authorization: Bearer {token}' \
         --output 'downloaded-media.jpg'
    ```
  </CodeBlockTab>

  <CodeBlockTab value="JavaScript (Fetch)">
    ```ts
    const myHeaders = new Headers();
    myHeaders.append("Authorization", "Bearer {token}");

    const cdnUrl =
      "https://cdn2.onlyfans.com/files/e/e5/123/600x400_123.jpg?Tag=2&u=123&Policy=123&Signature=signature&Key-Pair-Id=123";

    const requestOptions = {
      method: "GET",
      headers: myHeaders,
    };

    fetch(
      `https://app.onlyfansapi.com/api/{account}/media/download/${cdnUrl}`,
      requestOptions
    )
      .then((response) => response.blob())
      .then((blob) => {
        // Save the blob to a file or process it
        const url = window.URL.createObjectURL(blob);
        const a = document.createElement("a");
        a.href = url;
        a.download = "downloaded-media.jpg";
        a.click();
      })
      .catch((error) => console.error(error));
    ```
  </CodeBlockTab>

  <CodeBlockTab value="Node.js (Axios)">
    ```js
    const axios = require("axios");
    const fs = require("fs");

    const cdnUrl =
      "https://cdn2.onlyfans.com/files/e/e5/123/600x400_123.jpg?Tag=2&u=123&Policy=123&Signature=signature&Key-Pair-Id=123";

    let config = {
      method: "get",
      url: `https://app.onlyfansapi.com/api/{account}/media/download/${cdnUrl}`,
      headers: {
        Authorization: "Bearer {token}",
      },
      responseType: "stream",
    };

    axios
      .request(config)
      .then((response) => {
        response.data.pipe(fs.createWriteStream("downloaded-media.jpg"));
      })
      .catch((error) => {
        console.log(error);
      });
    ```
  </CodeBlockTab>

  <CodeBlockTab value="PHP (Guzzle)">
    ```php
    $client = new Client();

    $headers = [
        'Authorization' => 'Bearer {token}'
    ];

    $cdnUrl = "https://cdn2.onlyfans.com/files/e/e5/123/600x400_123.jpg?Tag=2&u=123&Policy=123&Signature=signature&Key-Pair-Id=123";

    $request = new Request('GET', "https://app.onlyfansapi.com/api/{account}/media/download/{$cdnUrl}", $headers);

    $res = $client->sendAsync($request)->wait();

    file_put_contents('downloaded-media.jpg', $res->getBody());
    ```
  </CodeBlockTab>
</CodeBlockTabs>

The endpoint streams the media file directly as a binary response, forwarding the upstream `Content-Type` from the OnlyFans CDN (e.g. `image/jpeg`, `video/mp4`, `audio/mpeg`). Save the response bytes to disk or process them as needed. There's no intermediate URL or re-hosted copy.

<Callout title="Detecting file type" type="info">
  Signed CDN URLs often carry query parameters (e.g. `?Tag=…&Signature=…`) and may not have a clean file extension. Inspect the response's `Content-Type` header to determine how to handle the file rather than parsing the URL.
</Callout>

## 🚀 Bulk downloads: export your entire Media Vault

Downloading the full Media Vault one CDN URL at a time is slow and rate-limited. For bulk use cases, use our [Data Exports](/data-exports) feature instead, which packages your entire Media Vault (every photo, video, and audio file) into a single ZIP file you can download once it's ready.

This is the recommended approach for:

* **AI / LoRA training datasets**: Get every asset in one archive instead of stitching together thousands of individual downloads. See [Download Media and Chats for LLM and LoRA Training](/data-exports/use-cases#download-media-and-chats-for-llm-and-lora-training) for a worked example.
* **Backups and platform migration**: Snapshot the full vault for disaster recovery or before switching platforms. See [Complete Data Backup and Migration](/data-exports/use-cases#complete-data-backup-and-migration).
* **Bulk content repurposing**: Pull your full media library at original quality for use elsewhere.

You can kick off a Media export from the [Data Exports dashboard](https://app.onlyfansapi.com/tools/data-export) (no code) or programmatically via the [Create Data Export API](/api-reference/data-exports/create-data-export). Big vaults may take several hours to package; you can close the browser and come back later to download the result.

## Migrating from the deprecated scrape endpoint

The previous [`POST /api/{account}/media/scrape`](/api-reference/media/deprecated-scrape-media-from-the-only-fans-cdn) endpoint is deprecated. If you have an existing integration built against it, here's what changes when you switch to the new download endpoint:

* **Response shape**: The deprecated endpoint re-hosted the file on the OnlyFans API CDN and returned a URL. The new endpoint streams the file binary directly in the response, so you'll need to save the bytes (not a URL) on your side.
* **File size limit**: The new endpoint has **no file size limit**. The deprecated endpoint capped uploads at 500MB.
* **Input format**: The new endpoint accepts a **CDN URL only**. Vault Media IDs (which the deprecated endpoint accepted) are not supported here.

# Connect Keitaro to OnlyFans API Smart Links (/introduction/guides/keitaro-smart-links)

import { Step, Steps } from "fumadocs-ui/components/steps";

## What the Keitaro integration does

Keitaro is a self-hosted traffic tracker and redirect platform used by media buyers. This integration connects Keitaro to OnlyFans API **Smart Links** so that every new subscriber you generate is reported straight back to Keitaro for attribution.

There are two halves: getting Keitaro's click ID into your Smart Link, then sending the conversion back to Keitaro when a subscription happens. Because Keitaro isn't a built-in Ad Platform, you wire it up with a Smart Links **Postback** (a plain GET request) rather than a paste-a-token connector.

<Callout>
  **What you'll need**

  * An active OnlyFans API account with **Smart Links** enabled
  * A **Smart Link** created for the creator you're promoting
  * A **Keitaro campaign** with an offer, plus your Keitaro **postback URL** (its domain and key)
</Callout>

## How the pieces connect

Keitaro's `{subid}` (its click ID) is passed into your Smart Link as `?ecid={subid}`, where it's saved as your external click ID. When a fan subscribes, the postback sends that value back to Keitaro as `{external_click_id}`, which Keitaro matches to the original click. The subscription amount flows the same way: OnlyFans API's `{amount_gross}` becomes Keitaro's `payout`.

## Step-by-step setup

<Steps>
  <Step>
    ### Point Keitaro's offer URL at your Smart Link

    In your Keitaro campaign, set the **offer URL** to your Smart Link with `?ecid={subid}` on the end:

    ```text
    https://trk.of-traffic.com/go/YOUR_SMART_LINK_ID?ecid={subid}
    ```

    Replace `YOUR_SMART_LINK_ID` with the ID from your Smart Links dashboard. `{subid}` is Keitaro's macro for the click ID: Keitaro swaps it for the real click ID when it redirects the visitor, and the Smart Link reads it from the `ecid` parameter and saves it.

    <Callout type="warn">
      This has to be the **offer URL set inside Keitaro** so Keitaro performs the `{subid}` substitution, not a raw link posted straight to your traffic source. If you post the link directly, `{subid}` is never replaced and no click ID is captured.
    </Callout>
  </Step>

  <Step>
    ### Create the postback in OnlyFans API

    Log into your [OnlyFans API Dashboard](https://app.onlyfansapi.com), open **Smart Links → Postbacks**, and create a new postback with these settings:

    * **HTTP method:** GET
    * **Conversion type:** `new_subscriber`
    * **Scope:** Global (or Campaign-specific with this Smart Link attached)
    * **URL:**

    ```text
    https://YOUR_KEITARO_DOMAIN/YOUR_POSTBACK_KEY/postback?subid={external_click_id}&status=sale&payout={amount_gross}
    ```

    A quick note on each value:

    * `{external_click_id}` outputs the Keitaro click ID captured in Step 1. This is what lets Keitaro match the conversion to the original click.
    * `status=sale` because a paid subscription is a confirmed sale. If this link is a free trial with no payment, use `status=lead` instead.
    * `{amount_gross}` is the subscription amount. Free-trial links send `0.00` here, which is expected.

    Keep the `YOUR_KEITARO_DOMAIN` and `YOUR_POSTBACK_KEY` parts exactly as they appear in your own Keitaro postback URL, those are yours from Keitaro.

    <Callout type="warn">
      Don't use `status=subscription`, Keitaro doesn't recognize that value. Use `status=sale` for a paid subscription or `status=lead` for a free trial.
    </Callout>
  </Step>

  <Step>
    ### Confirm it works after one real subscription

    1. Open your Smart Link and go to the **Clicks report**. The **External Click ID** column should show a value. If it does, Step 1 is working.
    2. In the **Conversions report**, you should see a `new_subscriber` row with an External Click ID next to it.
    3. The conversion should then show up in your Keitaro dashboard.

    <Callout>
      If the **External Click ID** column is empty in the Clicks report, the issue is Step 1 (Keitaro isn't passing the click ID in). Fix that first, no postback settings can work without it.
    </Callout>
  </Step>
</Steps>

## Keitaro ↔ OnlyFans API variables

| Keitaro                     | OnlyFans API                  | Notes                                                        |
| --------------------------- | ----------------------------- | ------------------------------------------------------------ |
| `{subid}` macro (offer URL) | passed in via `?ecid={subid}` | Keitaro replaces it with the click ID at redirect            |
| `subid` postback param      | `{external_click_id}`         | Matches the conversion back to the original click            |
| `payout` postback param     | `{amount_gross}`              | Gross subscription amount; `0.00` for free trials            |
| `status` postback param     | static `sale` / `lead`        | `sale` = paid sub, `lead` = free trial; never `subscription` |

<Callout type="info">
  For the full list of postback variables (net vs gross amounts, fan and creator info, transaction details) and every available conversion type, see the [Smart Links guide](/introduction/guides/onlyfans-meta-pixel-smart-links#available-postback-variables).
</Callout>

## Troubleshooting

| Problem                                                    | Fix                                                                                                                                                                            |
| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **External Click ID** column is empty in the Clicks report | Keitaro isn't passing the click ID. Make sure `?ecid={subid}` is on the **offer URL inside Keitaro** (not a raw link at your traffic source) so Keitaro substitutes `{subid}`. |
| Conversion shows in OnlyFans API but not in Keitaro        | Check the postback URL's domain and key match your Keitaro postback exactly, and that `subid={external_click_id}` is present.                                                  |
| Keitaro ignores or rejects the conversion status           | Use `status=sale` (paid) or `status=lead` (free trial). `status=subscription` is not recognized by Keitaro.                                                                    |
| `payout` shows `0.00`                                      | Expected for free-trial links (no payment). Paid subscriptions send the gross amount via `{amount_gross}`.                                                                     |

# Connect your Meta Pixel to OnlyFans API Smart Links (/introduction/guides/meta-pixel-smart-links)

import { Step, Steps } from "fumadocs-ui/components/steps";

## What is a Meta Pixel?

A Meta Pixel (now called a *dataset* in Events Manager) is Meta's conversion tracking tool for Facebook and Instagram ads. It tells Meta's ad platform when someone takes a valuable action, like subscribing or making a purchase, after clicking your ad. This data is what Meta's algorithm uses to find more people who are likely to convert, which lowers your cost per subscriber over time.

**Why connect it to Smart Links?** OnlyFans doesn't support Meta's pixel natively, and there's no way to install tracking code on OnlyFans pages. Smart Links bridge the gap by tracking everything **server-side** through Meta's Conversions API: every click, subscription, tip, and purchase is sent back to your Meta Pixel automatically. No JavaScript, nothing to install on OnlyFans.

<Callout>
  **What you'll need**

  * An active OnlyFans API account with **Smart Links** enabled
  * A **Meta Business** account with access to **Events Manager**
  * Your Meta **Pixel ID** *and* a **Conversions API access token** (we'll get both below)
</Callout>

## Why this matters for Meta

Most OnlyFans media buyers run Meta Ads, but Meta's pixel can't see what happens on OnlyFans: subscriptions, tips, PPV purchases, messages. Without conversion data flowing back, Meta optimizes for clicks, not buyers, and your cost-per-sub stays high.

* **Without conversion data**, Meta optimizes for link clicks and landing-page views. You pay for traffic that doesn't subscribe.
* **With Smart Links + your Meta Pixel**, every subscription and transaction is sent to Meta via the server-side Conversions API. Meta learns which clicks become paying fans and finds more people like them.

Meta's browser pixel is JavaScript that loads in the fan's browser, which makes it vulnerable to ad blockers, iOS tracking restrictions, cross-device loss, and redirect drop-off. Smart Links postbacks bypass all of that: our servers talk directly to Meta's Conversions API, so events can't be blocked or dropped.

<Callout type="info">
  This guide is the Meta-specific setup. For how Smart Links work under the hood, including attribution rules, the conversion window, lifetime revenue attribution, and postback variables, see the [Smart Links guide](/introduction/guides/onlyfans-meta-pixel-smart-links).
</Callout>

## Step-by-step setup

<Steps>
  <Step>
    ### Find your Meta Pixel ID

    In [Meta Events Manager](https://business.facebook.com/events_manager), open the **All Tools** menu and select **Events Manager**.

        <img alt="Meta Business: All Tools menu with Events Manager" src={__img0} placeholder="blur" />

    In Events Manager, open **Data Sets** and select your dataset. Your **Pixel ID** (also called the *Dataset ID*) is shown next to the dataset name. Copy it, then open the **Settings** tab to grab the access token next.

        <img alt="Meta Events Manager: Datasets with the Settings tab highlighted" src={__img1} placeholder="blur" />

    <Callout type="info">
      If you manage multiple businesses or clients, make sure you've selected the correct **Business** and **Pixel/Dataset** before copying the ID and generating the token below.
    </Callout>
  </Step>

  <Step>
    ### Generate a Conversions API access token

    Meta's server-side Conversions API needs an **access token** in addition to the Pixel ID. This is how Smart Links authenticate when sending events to Meta.

    With your dataset selected, open the **Settings** tab, scroll to the **Conversions API** section, and click **Generate access token**.

        <img alt="Meta Events Manager: Conversions API Generate access token" src={__img2} placeholder="blur" />

    <Callout type="warn">
      Copy the access token and keep it safe, and treat it like a password. Make sure the correct Pixel/Dataset is selected before generating, or the token won't match the Pixel ID you copied.
    </Callout>
  </Step>

  <Step>
    ### Create or open a Smart Link

    Log into your [OnlyFans API Dashboard](https://app.onlyfansapi.com) and open **Smart Links** in the left sidebar. Click **Create Smart Link** (or open an existing one) and fill in:

    * **Account**: the OnlyFans account you're running ads for
    * **Smart Link Name**: something descriptive, e.g. your Meta campaign name
    * **Offer Type**: *Free Trial* or *Tracking Link*

    <div className="mx-auto max-w-md">
            <img alt="OnlyFans API dashboard: Create Smart Link dialog" src={__img3} placeholder="blur" />
    </div>
  </Step>

  <Step>
    ### Add your Meta pixel

    Open **Smart Links → Ad Platforms** and click **Add Platform** (you can also pick platforms inline from the **Ad Platforms** selector when you create or edit a Smart Link). In the **Add Ad Platform** dialog:

    1. Set **Platform** to **Meta Ads**
    2. Paste your **Pixel ID** from Step 1
    3. Paste your **Conversions API access token** from Step 2 into the **Access Token** field
    4. Review the **Event Configuration**. The defaults are sensible (see [Events sent to Meta](#events-sent-to-meta) below)
    5. Click **Create**

    <div className="mx-auto max-w-md">
            <img alt="OnlyFans API dashboard: Add Ad Platform dialog with Meta Ads selected" src={__img4} placeholder="blur" />
    </div>
  </Step>

  <Step>
    ### Attach the pixel to your Smart Link

    If you added the platform from the **Ad Platforms** page rather than inline, attach it when you create or edit a Smart Link using the **Ad Platforms** selector. You can connect more than one platform to a single link. Once selected, it shows as **1 Platform** (or more).

    <div className="mx-auto max-w-md">
            <img alt="OnlyFans API dashboard: Meta pixel attached via the Ad Platforms selector" src={__img5} placeholder="blur" />
    </div>
  </Step>

  <Step>
    ### Send a test event

    In Meta Events Manager, open your dataset's **Test Events** tab and copy the **test event code**.

    Back in the OnlyFans API Dashboard, open the **Send Test Event** dialog on your pixel, pick an **Event**, paste the **Test Event Code**, and send it. Then check the **Test Events** tab in Meta, where your event should appear within a few minutes.

    <div className="mx-auto max-w-md">
            <img alt="OnlyFans API dashboard: Send Test Event dialog with a test event code" src={__img6} placeholder="blur" />
    </div>

    <Callout>
      Events sent with a test event code don't affect your live data. They're only for verifying the connection. The Test Event Code is **required** for Meta.
    </Callout>
  </Step>

  <Step>
    ### Use the Smart Link in your Meta ad

    In Meta Ads Manager, set your ad's **Website URL** to your Smart Link:

    ```text
    https://trk.of-traffic.com/go/YOUR_SMART_LINK_ID?ecid={{ad.id}}
    ```

    Replace `YOUR_SMART_LINK_ID` with the ID from your Smart Links dashboard. Meta automatically appends its click ID (`fbclid`) to the destination URL, and Smart Links reads it straight from the `fbclid` parameter to attribute conversions to your Meta Pixel. There's no macro to add for pixel tracking.

    The optional `?ecid={{ad.id}}` parameter passes Meta's Ad ID as your external click ID so you can match conversions back to specific ads in your own reporting. Swap in `{{campaign.id}}`, `{{adset.id}}`, or any other Meta dynamic parameter for the level of granularity you need.
  </Step>

  <Step>
    ### Verify conversions are flowing

    Once your ads are live:

    * **Smart Links dashboard**: you should see clicks, subscribers, and revenue
    * **Meta Events Manager**: conversion events appearing on your pixel (check the **Overview** and **Test Events** tabs)
    * **Meta Ads Manager**: the campaign's **Results** column filling in with tracked conversions
  </Step>
</Steps>

## Events sent to Meta

Smart Links can send the following events to your Meta Pixel. Each one maps to a Meta event in the **Event Configuration** section when you add the pixel. These are the defaults, and every event is configurable (map it to any Meta standard event, a custom event, or turn it off).

| Smart Link event              | When it fires                                             | Meta event (default)  |
| ----------------------------- | --------------------------------------------------------- | --------------------- |
| **Click**                     | Fan clicks the Smart Link and is redirected to OnlyFans   | `ViewContent`         |
| **New Subscriber**            | Fan subscribes through the Smart Link                     | `Subscribe`           |
| **First Purchase**            | Fan's first non-subscription transaction (tip, PPV, etc.) | `Purchase`            |
| **Repeat Purchase**           | Any transaction after the first                           | `Purchase`            |
| **Message Received from Fan** | Fan sends a message after converting                      | *Not sent by default* |
| **Fan Sent 3+ Messages**      | Fan reaches their 3rd inbound message                     | `Lead`                |

<Callout type="info">
  For subscriber and purchase events, Smart Links also sends the conversion **value** and **currency** when available, so Meta can optimize toward your highest-value fans, not just any conversion. The **Fan Sent 3+ Messages** event maps to `Lead` by default, and our top agencies optimize Meta around this high-signal event for the lowest cost-per-sub.
</Callout>

### Custom event mapping

The **Event Configuration** lets you map each Smart Link event to any Meta standard event, a custom event, or turn it off—so if the defaults don't match how you've set up your pixel, remap them.

For example, to send `CompleteRegistration` instead of `Subscribe`: open the pixel's **Event Configuration**, find **New Subscriber**, and set its Meta event to `CompleteRegistration`. Pick a custom event if you'd rather send an event name of your own.

## Which event should I optimize for?

This is the question most media buyers ask, and the answer changes as your campaign matures:

* **Starting out / building data:** optimize for **Subscribe** (`new_subscriber`). You get the most volume, which trains Meta's algorithm faster.
* **Improving subscriber quality / ROI:** switch to **Purchase** (`new_transaction`) so Meta optimizes toward people who actually spend, not just anyone who subscribes.
* **Advanced / highest signal:** optimize for **Lead** (`fan_sent_3_messages`). It's the highest-value signal and what our top agencies use for the lowest cost-per-sub.

See the [events table](#events-sent-to-meta) above for which Smart Link event maps to which Meta event by default.

## Understanding Event Match Quality (EMQ)

**Event Match Quality (EMQ)** is Meta's measure of how confidently it can match an event to a real person. The higher the score, the better Meta can attribute and optimize.

**What Smart Links sends with each event:** the Meta click ID (`fbc`, derived from the `fbclid` on the click), `fbp`, a hashed `external_id` (your `ecid` external click ID), the fan's IP address and user agent, and coarse location (country, city, state, postal code). These are strong signals for click-based attribution.

**Typical range:** Smart Link events usually score in the mid range—around **4-7** on Meta's Event Match Quality scale. Click-based attribution stays reliable even at a moderate score.

**Why not higher?** The highest scores require personal identifiers like email, phone, or name. Smart Links doesn't collect or send fan email, phone, or name by design, so it relies on click and device signals—which are enough for accurate attribution.

## Troubleshooting

| Problem                                              | Fix                                                                                                                                                                                                                                                                                                               |
| ---------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| No events showing in Meta                            | Double-check you pasted **both** the Pixel ID and the Conversions API access token, and that the token was generated for the **same** Pixel/Dataset as the ID.                                                                                                                                                    |
| Test event never appears                             | A **Test Event Code** is required for Meta. Copy it from your dataset's **Test Events** tab and paste it into the Send Test Event dialog. Allow a few minutes.                                                                                                                                                    |
| Events arrive but the campaign isn't optimizing      | Set your ad set's optimization goal to the matching conversion event (e.g. `Purchase` or `Subscribe`).                                                                                                                                                                                                            |
| Meta shows the pixel as inactive                     | Send a test event from the Smart Link settings to wake it up, then check the **Overview** tab.                                                                                                                                                                                                                    |
| Which domain do I whitelist for the Conversions API? | None. Events go server-side directly to Meta's Conversions API—there's no browser request to allowlist. The only domain fans interact with is `trk.of-traffic.com` (the redirect).                                                                                                                                |
| Conversions underreported from Instagram traffic     | Fans who open your link in the Instagram or Facebook in-app browser can lose attribution. Use a pre-lander that ejects to the device's native browser and forwards all query parameters. See the [Smart Links troubleshooting](/introduction/guides/onlyfans-meta-pixel-smart-links#troubleshooting) for details. |

# Meta Pixel-Like Revenue Tracking for OnlyFans Media Buyers (/introduction/guides/onlyfans-meta-pixel-smart-links)

## Pixel-Perfect Smart Links

Imagine you're running Meta Ads for a creator and you need to know which ad creative, which ad set, or which campaign is actually making money. Traditional pixels can miss events, get blocked by ad blockers, or lose data when users switch devices. **Smart Links solve all of that** with server-side tracking that never fails.

Think of a Smart Link as your one-stop tracking URL. You use it in your ads, and it automatically tracks everything: who clicked, who subscribed, and every dollar they spend—forever.

Here's what a Smart Link looks like:

```text
https://trk.of-traffic.com/go/XXXXXXXXXX?ecid={{YOUR_EXTERNAL_CLICK_ID}}
```

When someone clicks this link, here's what happens behind the scenes:

* We record the click instantly (no JavaScript needed)
* We create a unique connection between that click and the fan
* We track every subscription and transaction that fan makes
* We send you postbacks in real-time so you can optimize your campaigns

**The best part?** No pixels, no JavaScript, no lost events. It all happens server-side, so it's impossible to block or miss.

***

## Who This Is For

**Media buyers** who are tired of guessing which ads are profitable. Whether you're running Meta Ads, Google Ads, native traffic, push notifications, or adult traffic—Smart Links give you the accuracy you need to scale confidently.

**Agencies** managing multiple creators and dozens of campaigns. You need to know which creator's campaigns are performing, which traffic sources convert best, and where to double down your ad spend.

**Developers and BI teams** who need clean, reliable data. Smart Links provide deterministic attribution that you can trust for reporting, optimization, and building custom dashboards.

<Callout>
  **Do I have Smart Links?** Smart Links is a paid add-on—see [pricing](https://onlyfansapi.com/pricing) for details. Once it's enabled for your team, you can create Smart Links for any OnlyFans account connected to your team. **Tracking Links** work with any account, including free ($0 subscription) creator pages; **Free Trial** links require an account with a paid subscription price.
</Callout>

***

## How Smart Links Work (In Plain English)

Let's walk through a real scenario:

**SELECT AGENCY is running Meta Ads for a creator named Madison.** They create a Smart Link and use it as the destination URL in their Meta Ads campaign.

1. **A user named John sees SELECT AGENCY's ad** on Facebook and clicks it
2. **John gets redirected** through `trk.of-traffic.com` (this happens in 50-80ms—so fast he won't even notice)
3. **OnlyFans API generates a unique subscription link** just for John (this could be a free trial or paid subscription, depending on the creator's settings)
4. **John subscribes to Madison's page** and starts spending money on the creator
5. **Every transaction gets tracked** and sent to SELECT AGENCY via postbacks, so they know exactly which ad brought in John and how much he's worth

**Real-world performance:**

* Redirect happens in **50-80ms** (faster than most people can blink)
* **99.98% uptime** means it works when you need it
* No JavaScript means it works even when ad blockers are active

***

## Smart Link URL Structure

Here's the basic format:

```text
https://trk.of-traffic.com/go/{SMART_LINK_ID}?ecid={{EXTERNAL_CLICK_ID}}
```

You can replace the `{{EXTERNAL_CLICK_ID}}` parameter with any external click ID you want to track. This could be from Meta, Google Ads, or your own tracking system.

### Real Example

Let's say SELECT AGENCY has a creator called Madison who wants to track her Meta Ads campaign. They create a Smart Link in the dashboard and get this ID: `01KE2JN9RBPAZNYSXKMYHR4JP2`

In Meta Ads, they set up their campaign to pass the click ID as a parameter. Their final tracking URL looks like:

```text
https://trk.of-traffic.com/go/01KE2JN9RBPAZNYSXKMYHR4JP2?ecid={{ad.id}}
```

When a user clicks the ad, Meta's system automatically replaces `{{ad.id}}` with the Ad ID from their platform, so SELECT AGENCY can match conversions back to specific ads in Meta's dashboard.

### Parameters

| Parameter       | Required | Description                                                                                                                     |
| --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `SMART_LINK_ID` | ✅        | Your unique Smart Link ID. Find it in the [Smart Links dashboard](https://app.onlyfansapi.com/smart-links) after you create one |
| `ecid`          | ❌        | Any external click ID you want to track. This could be from Meta, Google Ads, or your own tracking system                       |

***

## Attribution Rules (What You Need to Know)

### Click Deduplication & Fraud Prevention

**The problem:** Some users (or bots) might click your ad multiple times, inflating your click numbers and making it look like you're getting more traffic than you actually are.

**The solution:** Smart Links use browser fingerprinting to detect and prevent double-clicks. Each legitimate click gets a globally unique `click_id` that you can use to track that specific user's journey.

**Real example:** If John accidentally double-clicks SELECT AGENCY's ad, we'll only count it as one click. But if John clicks, then his friend Mike clicks from a different device, we'll count both as separate clicks.

### Conversion Window

**How it works:** When someone clicks your Smart Link, they have **6 hours** to subscribe. If they subscribe within that window, the conversion is attributed to your click.

**Why this matters:** This prevents old clicks from getting credit for new subscribers. If someone clicked your ad last week but only subscribes today after seeing a different ad, the attribution goes to the most recent click.

**Real scenario:** John clicks SELECT AGENCY's ad at 2:00 PM. He browses around, checks out the creator's social media, and finally subscribes at 5:30 PM. That conversion is attributed to that ad click. But if John waits until the next day (more than 6 hours later), the attribution window has closed.

### Click → Fan Binding

Once a fan is bound to a click, they stay bound unless something significant changes:

* They switch to a different browser or device
* The `?ecid=` parameter changes

**What this means:** If John subscribes after clicking your Smart Link, all of his future spending is attributed to that original click—even if he comes back days or weeks later.

### Multiple Smart Links: Who Gets Credit?

**The rule:** Attribution always goes to the **most recently clicked Smart Link**.

**Real-world scenario:**

* Monday: John clicks SELECT AGENCY's Smart Link A (Meta Ads campaign)
* John subscribes → attributed through the Smart Link A
* John spends $50 over the next two weeks → all attributed through the Smart Link A
* Two weeks later: John clicks SELECT AGENCY's Smart Link B (Google Ads campaign)
* From that moment forward, all of John's spending is attributed through the Smart Link B

Smart Links are **creator-scoped**, meaning attribution rules only apply within the same creator's account. If John clicks a Smart Link for Creator A (Madison), then later clicks a Smart Link for Creator B (Sarah), each creator's attribution is tracked separately—clicking Creator B's link doesn't affect attribution for Creator A.

***

## Lifetime Revenue Attribution (The Game Changer)

This is where Smart Links really shine. Once a fan subscribes through your Smart Link, **every dollar they spend** gets attributed to your original click—forever.

### Real Example Timeline

Let's follow John's journey:

```text
Monday, Jan 1 at 12:00 PM
  → John clicks SELECT AGENCY's Smart Link A (Meta Ads / Madison / Creative #1)
  
Monday, Jan 1 at 12:10 PM
  → John subscribes to Madison's page ($10/month)
  → Attribution: Smart Link A
  
Tuesday, Jan 2 at 3:00 PM
  → John tips $25 for a PPV message
  → Attribution: Smart Link A (still!)
  
Monday, Jan 15 at 12:00 PM
  → John's subscription renews ($10/month)
  → Attribution: Smart Link A (yes, renewals count too!)
  
Monday, Jan 20 at 2:00 PM
  → John clicks SELECT AGENCY's Smart Link B (Google Ads / Madison / Creative #2)
  → Attribution switches to Smart Link B
  
Monday, Jan 20 at 2:05 PM
  → John tips $15
  → Attribution: Smart Link B (newest click wins)
```

**Why this matters:** SELECT AGENCY can see that their Meta Ads campaign (Smart Link A) generated $45 in revenue from John, even though he only subscribed once. This gives them the true lifetime value (LTV) of their ad spend, not just the initial subscription.

***

## Events & Postbacks (Getting Your Data)

Smart Links send you real-time notifications when important things happen. You choose which of these **conversion types** to fire postbacks for when you set up your Smart Link:

| Conversion Type         | Slug                  | When It Fires                                                                                   |
| ----------------------- | --------------------- | ----------------------------------------------------------------------------------------------- |
| **New subscriber**      | `new_subscriber`      | A fan subscribed through this Smart Link                                                        |
| **New transaction**     | `new_transaction`     | A fan who subscribed through this Smart Link spent money (tip, PPV, renewal, etc.)              |
| **Message received**    | `message_received`    | A fan sent an inbound message after converting through this Smart Link                          |
| **Fan sent 3 messages** | `fan_sent_3_messages` | Sent once when the fan sends their 3rd inbound message after converting through this Smart Link |

**How postbacks work:**

* They're **GET requests** (simple URL calls)
* They're **fire-and-forget** (we send them, but don't wait for a response)
* They might arrive out of order (so make sure your system can handle that)
* Each event has a globally unique `click_id` so you can match it to the original click

### When Does Data Update?

**New subscribers:** near real-time. A new subscriber is usually detected within **30 seconds to a few minutes** of subscribing.

**Tips, PPV, renewals, and other transactions:** typically within minutes, though they can occasionally take a little longer. The revenue in your dashboard refreshes periodically.

**Historical data:** we can only show data from the day a link was first seen on OnlyFans API—usually the day you connected the account. There's no lifetime history from before that point.

**Forcing a refresh:** there's no button or endpoint to force a refresh for a specific link. Data updates automatically on the schedule above.

### Setting Up Postbacks: Real Examples

**Example 1: Meta Pixel Integration**

SELECT AGENCY wants to send conversions back to Meta so they can optimize their campaigns. They set up a postback URL like this:

```text
https://www.facebook.com/tr?id=YOUR_PIXEL_ID&ev=Purchase&cd[value]={amount_gross}&cd[currency]=USD&external_id={external_click_id}
```

When someone subscribes, Meta gets notified with the exact revenue amount, and SELECT AGENCY can see it in their Meta Ads dashboard.

**Example 2: Custom Tracking System**

Mike runs his own tracking system and wants to log all conversions. He sets up a postback URL:

```text
https://tracking.mikeads.com/webhook?click_id={external_click_id}&amount={amount_net}&fan_id={fan_onlyfans_id}&conversion_type={conversion_type}
```

His system receives the data and stores it in his database for reporting.

**Example 3: Slack Notifications**

An agency wants to get notified in Slack when big conversions happen. They set up:

```text
https://hooks.slack.com/services/YOUR/WEBHOOK/URL?text=New+{conversion_type}+from+{creator_onlyfans_username}+%24{amount_gross}
```

Now they get instant notifications when subscribers convert.

### Available Postback Variables

You can use these variables in your postback URL to get the data you need:

#### Creator Information

| Variable                      | Description                           | Example                      |
| ----------------------------- | ------------------------------------- | ---------------------------- |
| `{ofapi_account_id}`          | The Creator's OnlyFans API Account ID | `acct_XXXXXXXXXXXXXXXXXXXXX` |
| `{creator_onlyfans_id}`       | The Creator's OnlyFans User ID        | `1234567890`                 |
| `{creator_onlyfans_username}` | The Creator's OnlyFans Username       | `madison420ivy`              |
| `{creator_onlyfans_name}`     | The Creator's Profile Name            | `Madison Ivy`                |

#### Smart Link Information

| Variable            | Description                                               | Example                           |
| ------------------- | --------------------------------------------------------- | --------------------------------- |
| `{smart_link_id}`   | The Smart Link ID                                         | `01KE2JN9RBPAZNYSXKMYHR4JP2`      |
| `{smart_link_name}` | The Smart Link Name (you set this when creating the link) | `Meta Ads / Madison / Creative A` |

#### Conversion Details

| Variable              | Description                                                | Example                                                                           |
| --------------------- | ---------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `{conversion_type}`   | The type of conversion                                     | `new_subscriber`, `new_transaction`, `message_received`, or `fan_sent_3_messages` |
| `{click_id}`          | The unique click ID from when they first clicked           | `01ke2ndttgbvnmaxegbyhr9z3v`                                                      |
| `{external_click_id}` | The external click ID you passed in the URL (via `?ecid=`) | `meta-click-12345` or `google-ads-67890`                                          |
| `{conversion_at}`     | When the conversion happened (UTC)                         | `2026-01-04T04:40:40+00:00`                                                       |
| `{amount_gross}`      | The total amount before OnlyFans takes their cut           | `10.00` (for a $10 subscription)                                                  |
| `{amount_net}`        | The amount after OnlyFans takes their 20% cut              | `8.00` (your actual revenue)                                                      |

#### Fan Information

| Variable                  | Description                 | Example      |
| ------------------------- | --------------------------- | ------------ |
| `{fan_onlyfans_id}`       | The Fan's OnlyFans User ID  | `999999999`  |
| `{fan_onlyfans_username}` | The Fan's OnlyFans Username | `johndoe123` |
| `{fan_onlyfans_name}`     | The Fan's Profile Name      | `John Doe`   |

#### Transaction Details (only for `new_transaction` events) ⚠️

| Variable                    | Description                           | Example                                                                                      |
| --------------------------- | ------------------------------------- | -------------------------------------------------------------------------------------------- |
| `{transaction_type}`        | What kind of transaction it was       | `new_subscription`, `recurring_subscription`, `tip`, `post`, `message`, `stream`, or `other` |
| `{transaction_description}` | A description of the transaction      | `Payment for message from <a href="https://onlyfans.com/u999999999">John Doe</a>`            |
| `{transaction_status}`      | The current status of the transaction | `loading`, `done`, `pending_return`, or `undo`                                               |

***

## Financial Details (The Money Stuff)

**Currency:** All amounts are in **USD**

**Precision:** All amounts are rounded to **2 decimal places**

**Understanding Gross vs Net:**

* `{amount_gross}` = The total amount the fan paid (before OnlyFans takes their cut)
* `{amount_net}` = The amount the creator actually receives (after OnlyFans takes their 20% cut)

**Real example:**

* John subscribes for $10/month
* `{amount_gross}` = `10.00`
* `{amount_net}` = `8.00` (OnlyFans keeps $2, creator gets $8)

**Why this matters:** When you're calculating ROI, you probably want to use `{amount_net}` since that's what the creator actually earns. But if you're tracking total customer value, `{amount_gross}` shows the full amount the fan spent.

***

## Dashboard & Reporting (See Your Results)

The Smart Links dashboard gives you everything you need to understand your campaign performance:

**Key Metrics:**

* **Clicks** - How many people clicked your link
* **Subscribers** - How many of those clicks converted to subscribers
* **Revenue** - Total revenue generated (you can toggle between gross and net)
* **CR %** - Conversion rate (subscribers ÷ clicks)
* **ARPS** - Average Revenue Per Subscriber

<Callout>
  Revenue defaults to **gross** (the total amount the fan paid). Toggle to **net** to see the creator's earnings after the OnlyFans 20% platform fee.
</Callout>

**Reports:**

* **Clicks Report** - See when clicks happened with a time-series chart and detailed table
* **Conversions Report** - See when conversions happened with revenue breakdowns

**Real use case:** SELECT AGENCY runs three different ad creatives and wants to know which one is most profitable. They create three Smart Links (one for each creative) and compare them in the dashboard. They can see that Creative A has a 3.2% conversion rate and $45 ARPS, while Creative B has a 2.1% conversion rate and $32 ARPS. They double down on Creative A.

***

## Common Use Cases

### Use Case 1: Tracking Multiple Ad Creatives

**The problem:** You're testing 5 different ad creatives and need to know which one converts best.

**The solution:** Create 5 Smart Links (one for each creative) and use them as destination URLs in your ad platform. Compare conversion rates and revenue in the dashboard.

### Use Case 2: Tracking by Traffic Source

**The problem:** You're running ads on Meta, Google, and native networks. Which source is most profitable?

**The solution:** Create separate Smart Links for each traffic source. Name them clearly (e.g., "Meta Ads", "Google Ads", "Native - TrafficJunky") so you can easily compare in reports.

### Use Case 3: Tracking by Country or Campaign

**The problem:** You want to know if your US campaigns perform better than your UK campaigns.

**The solution:** Create Smart Links with descriptive names like "Meta Ads - US" and "Meta Ads - UK". Use the `?ecid=` parameter to pass additional data like campaign ID or ad set ID from your ad platform.

### Use Case 4: Agency Reporting

**The problem:** You manage 10 creators and need to show each one which campaigns are working.

**The solution:** Create Smart Links with creator names in them (e.g., "Meta Ads - Madison", "Meta Ads - Sarah"). Use the dashboard filters to show each creator their specific performance.

### Use Case 5: Smart Links with Landing Pages

**The problem:** You send traffic to a landing page with a call-to-action button first, instead of straight to OnlyFans, but you still want full attribution. The flow is Ad → Landing Page → CTA button → OnlyFans.

**The solution:** Use your Smart Link URL as the `href` on your CTA button. The redirect happens in 50-80ms, so visitors won't notice the extra hop. To preserve attribution, make sure your landing page forwards its incoming query parameters (`fbclid`, `ecid`, `utm_*`, etc.) through to the Smart Link URL—otherwise the click data is lost at the landing page.

If your traffic comes from Instagram or another in-app browser, see [Troubleshooting](#troubleshooting) for an important note on pre-landers.

***

## Sending to Multiple Ad Platforms

You're not limited to one pixel per Smart Link. You can attach **more than one ad platform** to a single Smart Link, so one link fires events to several pixels at once.

**How it works:** Add each platform on the **Ad Platforms** page (**Add Platform**), then attach the ones you want to a Smart Link using the **Ad Platforms** selector when you create or edit it. The selector shows how many are attached—**1 Platform**, **2 Platforms**, and so on.

**Common setups:**

* Two Meta Pixels on one link (e.g. an agency pixel and a client pixel)
* Meta + TikTok on the same link, so both platforms get conversion data from the same traffic

For per-platform setup, see the [Meta Pixel guide](/introduction/guides/meta-pixel-smart-links).

***

## Auto-Add Subscribers to a List

Smart Links can automatically add new subscribers to one of your OnlyFans lists, so you can segment ad-driven fans for targeted mass messages and campaigns.

**How it works:** When you create or edit a Smart Link, use the optional **Add New Subscribers to List** setting to pick an existing OnlyFans list (or create a new one on the spot). Any fan who **subscribes** through that link is added to the selected list automatically.

**Good to know:**

* It applies to **new subscribers only**—not tips, PPV purchases, or messages.
* You can only choose lists that OnlyFans allows adding fans to, and the connected account needs an active session for the fan to be added.

***

## Troubleshooting

**Conversions look underreported?** Here are the most common causes, roughly in order of how often they come up:

* **The fan opened your link in an in-app browser (Instagram, X, etc.)—this is the #1 cause.** Links tapped inside Instagram's or X's in-app browser can break attribution. Use a **pre-lander** that ejects the in-app browser into the device's native browser and **forwards all query parameters** to your Smart Link—for example [link.me](https://link.me), [linkscale.to](https://linkscale.to), [juicy.bio](https://juicy.bio), or a custom one. If a fan lands on `link.me/username?fbclid=123456&utm_source=instagram`, the pre-lander must forward those to `trk.of-traffic.com/go/XXXX?fbclid=123456&utm_source=instagram` so attribution is preserved.
* **The 6-hour attribution window expired.** The fan clicked but didn't subscribe until more than 6 hours later, so the click no longer gets credit.
* **The account needs re-authentication.** If the connected account's session is dead, the Smart Link can't generate inventory (subscription links), so there's nothing to attribute.
* **The fan switched browser or device** between clicking and subscribing.
* **Multiple Smart Links:** credit always goes to the **most recently clicked** link.
* **Custom domains aren't supported.** The tracking domain is `trk.of-traffic.com` only.

***

## Summary

Smart Links give you **server-side, pixel-perfect attribution** that you can actually trust. No more guessing which ads are profitable, no more lost conversions, no more incomplete data. Just clean, accurate tracking that helps you scale your media buying with confidence.

Whether you're a solo media buyer or an agency managing dozens of campaigns, Smart Links provide the accuracy you need to make data-driven decisions and maximize your ROI.

# Connect your Snapchat Pixel to OnlyFans API Smart Links (/introduction/guides/snapchat-pixel-smart-links)

import { Step, Steps } from "fumadocs-ui/components/steps";

## What is a Snapchat Pixel?

A Snapchat Pixel is Snapchat's conversion tracking tool. It tells Snapchat's ad platform when someone takes a valuable action, like subscribing or making a purchase, after seeing or swiping up on your Snap ad. This data is what Snapchat's algorithm uses to find more users who are likely to convert, which lowers your cost per subscriber over time.

**Why connect it to Smart Links?** OnlyFans doesn't support Snapchat's pixel natively, and there's no way to install tracking code on OnlyFans pages. Smart Links bridge the gap by tracking everything **server-side**: every click, subscription, tip, and purchase is sent back to your Snapchat Pixel automatically. No JavaScript, nothing to install on OnlyFans.

<Callout>
  **What you'll need**

  * An active OnlyFans API account with **Smart Links** enabled
  * A **Snapchat Ads** account with **Business Manager** access (you must be an *Organization Admin* to generate the API token)
  * Your Snap **Pixel ID** *and* a **Conversions API token** (we'll get both below)
</Callout>

## Why this matters for Snapchat

Snapchat is a strong traffic source for OnlyFans media buyers, especially for younger demographics and creative formats like Stories ads and AR Lenses. But like every platform, Snapchat's algorithm only optimizes well when it has conversion data.

* **Without conversion data**, Snapchat optimizes for swipe-ups (clicks), not subscribers. You pay for traffic that doesn't convert.
* **With Smart Links + your Snapchat Pixel**, every subscription and transaction is sent to Snapchat via server-side postbacks. Snapchat learns which swipe-ups become paying fans and finds more of them.

Snapchat's native pixel is browser-based JavaScript, which makes it vulnerable to ad blockers, cross-device loss, and redirect drop-off. Smart Links postbacks bypass all of that: our servers talk directly to Snapchat's Conversions API, so events can't be blocked or dropped.

<Callout type="info">
  This guide is the Snapchat-specific setup. For how Smart Links work under the hood, including attribution rules, the conversion window, lifetime revenue attribution, and postback variables, see the [Smart Links guide](/introduction/guides/onlyfans-meta-pixel-smart-links).
</Callout>

## Step-by-step setup

<Steps>
  <Step>
    ### Find your Snap Pixel ID

    In [Snapchat Ads Manager](https://ads.snapchat.com), open the top menu and go to **Assets → Pixels** (Snapchat also lists pixel activity under **Events Manager**).

        <img alt="Snapchat Business Manager: menu with Assets → Pixels highlighted" src={__img0} placeholder="blur" />

    On the Pixels page, open your pixel, or click **Create Pixel**, name it, and open it.

        <img alt="Snapchat: Pixels overview page with Create Pixel" src={__img1} placeholder="blur" />

    Your **Pixel ID** is shown right below the pixel's name. Copy it.

        <img alt="Snapchat: pixel details page showing the Pixel ID" src={__img2} placeholder="blur" />
  </Step>

  <Step>
    ### Generate a Conversions API token

    Snapchat's server-side Conversions API needs an **access token** in addition to the Pixel ID. This is how Smart Links authenticate when sending events to Snapchat.

    In the sidebar, open **Business Details**, scroll to **Conversions API Tokens**, and click **Generate Token** (or copy an existing one).

        <img alt="Snapchat: Business Details with the Conversions API Tokens section" src={__img3} placeholder="blur" />

    <Callout type="warn">
      You must be an **Organization Admin** to generate this token. Copy it somewhere safe and treat it like a password. Store it on a secure backend, and never share it client-side.
    </Callout>
  </Step>

  <Step>
    ### Create or open a Smart Link

    Log into your [OnlyFans API Dashboard](https://app.onlyfansapi.com) and open **Smart Links** in the left sidebar. Click **Create Smart Link** (or open an existing one) and fill in:

    * **Account**: the OnlyFans account you're running ads for
    * **Smart Link Name**: something descriptive, e.g. your Snapchat campaign name
    * **Offer Type**: *Free Trial* or *Tracking Link*

    <div className="mx-auto max-w-md">
            <img alt="OnlyFans API dashboard: Create Smart Link dialog" src={__img4} placeholder="blur" />
    </div>
  </Step>

  <Step>
    ### Add your Snapchat pixel

    On the Smart Link, open the **Connect your ad platforms** panel and click **Add connection** (you can also manage pixels from **Smart Links → Ad Platforms**). Then:

    1. Set **Platform** to **Snapchat Ads**
    2. Paste your **Pixel ID** from Step 1
    3. Paste your Conversions API token into the **Access Token** field (from Step 2)
    4. Review the **Event Configuration**. The defaults are sensible (see [Events sent to Snapchat](#events-sent-to-snapchat) below)
    5. Click **Create**

    <div className="mx-auto max-w-md">
            <img alt="OnlyFans API dashboard: Add Tracking Pixel dialog with Snapchat Ads selected" src={__img5} placeholder="blur" />
    </div>
  </Step>

  <Step>
    ### Attach the pixel to your Smart Link

    If you created the pixel from the **Ad Platforms** page rather than inline, attach it to the Smart Link using the **Ad Platforms** selector on the Smart Link. You can connect more than one pixel to a single link.

    <div className="mx-auto max-w-md">
            <img alt="OnlyFans API dashboard: Snapchat pixel attached via the Ad Platforms selector" src={__img6} placeholder="blur" />
    </div>
  </Step>

  <Step>
    ### Send a test event

    Open the **Send Test Event** dialog on your pixel, pick an **Event**, and send it. **Snapchat doesn't use a test event code.** The event goes to Snapchat's validation endpoint and appears in Snapchat Events Manager under your pixel's **Test Events** tab within a few minutes.

    <div className="mx-auto max-w-md">
            <img alt="OnlyFans API dashboard: Send Test Event dialog for a Snapchat pixel" src={__img7} placeholder="blur" />
    </div>
  </Step>

  <Step>
    ### Use the Smart Link in your Snapchat ad

    In Snapchat Ads Manager, set your ad's **Website URL** / **Attachment URL** to your Smart Link:

    ```text
    https://trk.of-traffic.com/go/YOUR_SMART_LINK_ID
    ```

    Replace `YOUR_SMART_LINK_ID` with the ID from your Smart Links dashboard. When a Snapchatter swipes up, Snapchat automatically appends its click ID (`ScCid`) to the URL, and Smart Links captures it for attribution. There's no macro to add.
  </Step>

  <Step>
    ### Verify conversions are flowing

    Once your ads are live:

    * **Smart Links dashboard**: you should see clicks, subscribers, and revenue
    * **Snapchat Events Manager**: conversion events appearing on your pixel
    * **Snapchat Ads Manager**: your campaign's results filling in with tracked conversions
  </Step>
</Steps>

## Events sent to Snapchat

Smart Links can send the following events to your Snapchat Pixel. Each one maps to a Snapchat event in the **Event Configuration** section when you add the pixel. These are the defaults, and every event is configurable (map it to any Snapchat standard event, a custom event, or turn it off).

| Smart Link event              | When it fires                                             | Snapchat event (default) |
| ----------------------------- | --------------------------------------------------------- | ------------------------ |
| **Click**                     | Fan clicks the Smart Link and is redirected to OnlyFans   | `VIEW_CONTENT`           |
| **New Subscriber**            | Fan subscribes through the Smart Link                     | `SIGN_UP`                |
| **First Purchase**            | Fan's first non-subscription transaction (tip, PPV, etc.) | `PURCHASE`               |
| **Repeat Purchase**           | Any transaction after the first                           | `PURCHASE`               |
| **Message Received from Fan** | Fan sends a message after converting                      | *Not sent by default*    |
| **Fan Sent 3+ Messages**      | Fan reaches their 3rd inbound message                     | `LEVEL_COMPLETE`         |

<Callout type="info">
  For subscriber and purchase events, Smart Links also sends the conversion **value** and **currency** when available, so Snapchat can optimize toward your highest-value fans, not just any conversion.
</Callout>

## Troubleshooting

| Problem                                                        | Fix                                                                                                                                                 |
| -------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| No events showing in Snapchat                                  | Double-check you pasted **both** the Pixel ID and the Conversions API token, and that the token was generated by an **Organization Admin**.         |
| Pixel shows invalid right after creating your business account | Snapchat can take up to a day to activate a brand-new pixel, so wait and try again.                                                                 |
| Test event never appears                                       | Snapchat doesn't use a test event code. Just send the test event and check your pixel's **Test Events** tab in Events Manager. Allow a few minutes. |
| Events arrive but the campaign isn't optimizing                | Set your campaign's optimization goal to the matching conversion event (e.g. `PURCHASE` or `SIGN_UP`).                                              |

# Text formatting (/introduction/guides/text-formatting)

## Best practices

Generally, all text should be contained within one singular `<p>` tag. Example:

```html
<p>
    Hi there! This is a message containing normal text
</p>
```

## New lines

To create a new line, you can use the `<br>` tag. Example:

```html
<p>
    Hi there! This is a message containing normal text
    <br>
    This is a new line!
</p>
```

Which will render as:

> Hi there! This is a message containing normal text\
> This is a new line!

## Text sizes

OnlyFans has the following text size options:

* Largest
* Large
* Default
* Small
* Smallest

<img alt="OnlyFans text size options" src={__img0} placeholder="blur" />

You can use them as follows:

### Smallest

To create the smallest text, you can use the `<span class="m-editor-fs__sm">` tag. Example:

```html
<p>
    Hi there! This is a message containing normal text
    <span class="m-editor-fs__sm">This is the smallest text!</span>
</p>
```

### Small

To create a small text, you can use the `<span class="m-editor-fs__s">` tag. Example:

```html
<p>
    Hi there! This is a message containing normal text
    <span class="m-editor-fs__s">This is a small text!</span>
</p>
```

### Large

To create a large text, you can use the `<span class="m-editor-fs__l">` tag. Example:

```html
<p>
    Hi there! This is a message containing normal text
    <span class="m-editor-fs__l">This is a large text!</span>
</p>
```

### Largest

To create the largest text, you can use the `<span class="m-editor-fs__lg">` tag. Example:

```html
<p>
    Hi there! This is a message containing normal text
    <span class="m-editor-fs__lg">This is the largest text!</span>
</p>
```

## Text styles

When using text styles like **bold** or *italic*, make sure that you wrap the text in a `<span class="m-editor-fs__default">` tag. Example:

```html
<span class="m-editor-fs__default">
    <strong>Bold text</strong>
    <em>Italic text</em>
</span>
```

### Bold

To create bold text, you can use the `<strong>` tag. Example:

```html
<p>
    Hi there! This is a message containing normal text
    <span class="m-editor-fs__default"><strong>This is bold text!</strong></span>
</p>
```

### Italic

To create italic text, you can use the `<em>` tag. Example:

```html
<p>
    Hi there! This is a message containing normal text
    <span class="m-editor-fs__default"><em>This is italic text!</em></span>
</p>
```

## Text colors

OnlyFans has three possible colors for text:

* Gray (`#8a96a3`)
* Blue 1 (`#00aff0`)
* Blue 2 (`#1b98e0`)

<img alt="OnlyFans text color options" src={__img1} placeholder="blur" />

You can use them as follows:

### Gray

To create gray text, you can use the `<span class="m-editor-fs__default m-editor-fc__gray">` tag. Example:

```html
<p>
    Hi there! This is a message containing normal text
    <span class="m-editor-fs__default m-editor-fc__gray">This is gray text!</span>
</p>
```

### Blue 1

To create blue 1 text, you can use the `<span class="m-editor-fs__default m-editor-fc__blue-1">` tag. Example:

```html
<p>
    Hi there! This is a message containing normal text
    <span class="m-editor-fs__default m-editor-fc__blue-1">This is blue 1 text!</span>
</p>
```

### Blue 2

To create blue 2 text, you can use the `<span class="m-editor-fs__default m-editor-fc__blue-2">` tag. Example:

```html
<p>
    Hi there! This is a message containing normal text
    <span class="m-editor-fs__default m-editor-fc__blue-2">This is blue 2 text!</span>
</p>
```

# Connect your TikTok Pixel to OnlyFans API Smart Links (/introduction/guides/tiktok-pixel-smart-links)

import { Step, Steps } from "fumadocs-ui/components/steps";

## What is a TikTok Pixel?

A TikTok Pixel is TikTok's conversion tracking tool. It tells TikTok's ad platform when someone takes a valuable action, like subscribing or making a purchase, after clicking your TikTok ad. This data is what TikTok's algorithm uses to find more users who are likely to convert, which lowers your cost per subscriber over time.

**Why connect it to Smart Links?** OnlyFans doesn't support TikTok's pixel natively, and there's no way to install tracking code on OnlyFans pages. Smart Links bridge the gap by tracking everything **server-side**: every click, subscription, tip, and purchase is sent back to your TikTok Pixel automatically. No JavaScript, nothing to install on OnlyFans.

<Callout>
  **What you'll need**

  * An active OnlyFans API account with **Smart Links** enabled
  * A **TikTok Ads Manager** account
  * Your TikTok **Pixel ID** *and* an **Events API Access Token** (we'll generate both below)
</Callout>

## Why this matters for TikTok

TikTok is one of the highest-volume traffic sources for OnlyFans media buyers, and its algorithm is exceptional at finding the right audience. *That only works when it has conversion data to optimize against.*

* **Without conversion data**, TikTok optimizes for video views or clicks. You get cheap traffic that doesn't convert, and cost-per-sub stays unpredictable.
* **With Smart Links + your TikTok Pixel**, every subscription and transaction is sent to TikTok via server-side postbacks. TikTok learns which users actually subscribe and spend, then serves your ads to people who look like your best fans.

TikTok's native pixel is browser-based JavaScript, which makes it vulnerable to ad blockers (especially on mobile, where most TikTok users browse), cross-device loss, and cookie restrictions. Smart Links postbacks bypass all of that: our servers talk directly to TikTok's servers, so events can't be blocked or dropped.

<Callout type="info">
  This guide is the TikTok-specific setup. For how Smart Links work under the hood, including attribution rules, the conversion window, lifetime revenue attribution, and postback variables, see the [Smart Links guide](/introduction/guides/onlyfans-meta-pixel-smart-links).
</Callout>

## Step-by-step setup

<Steps>
  <Step>
    ### Find your TikTok Pixel ID

    In [TikTok Ads Manager](https://ads.tiktok.com), open **Tools** in the top navigation and click **Events** (under *Management*).

        <img alt="TikTok Ads Manager: Tools menu with Events highlighted" src={__img0} placeholder="blur" />

    <Callout type="info">
      Depending on your account, TikTok may label this area **Tools → Events** or **Assets → Events → Web Events**. Both lead to the same Events Manager.
    </Callout>

    In Events Manager, click **Get started**, choose **Web** as your data source, and click **Next**.

        <img alt="TikTok Events Manager: Select data source dialog with Web selected" src={__img1} placeholder="blur" />

    Give your pixel a name, select **TikTok Pixel** as the connection method, and continue. Once created, your pixel's **ID** is shown at the top of its **Overview** tab. Copy it.

        <img alt="TikTok pixel Overview tab showing the Pixel ID" src={__img2} placeholder="blur" />
  </Step>

  <Step>
    ### Generate an Access Token

    TikTok's server-side Events API needs an **Access Token** in addition to the Pixel ID. This is how Smart Links authenticate when sending events to TikTok.

    On your pixel, open the **Settings** tab, scroll to **Events API → Access Token Generation**, and click **Generate Access Token**.

        <img alt="TikTok pixel Settings: Events API Generate Access Token button" src={__img3} placeholder="blur" />

    <Callout type="warn">
      Copy the access token immediately and keep it safe. TikTok only shows it once. If you lose it, generate a new one.
    </Callout>
  </Step>

  <Step>
    ### Create or open a Smart Link

    Log into your [OnlyFans API Dashboard](https://app.onlyfansapi.com) and open **Smart Links** in the left sidebar. Click **Create Smart Link** (or open an existing one) and fill in:

    * **Account**: the OnlyFans account you're running ads for
    * **Smart Link Name**: something descriptive, e.g. your TikTok campaign name
    * **Offer Type**: *Free Trial* or *Tracking Link*

    <div className="mx-auto max-w-md">
            <img alt="OnlyFans API dashboard: Create Smart Link dialog" src={__img4} placeholder="blur" />
    </div>
  </Step>

  <Step>
    ### Add your TikTok pixel

    On the Smart Link, open the **Connect your ad platforms** panel and click **Add connection** (you can also manage pixels from **Smart Links → Ad Platforms**). Then:

    1. Set **Platform** to **TikTok Ads**
    2. Paste your **Pixel ID** from Step 1
    3. Paste your **Access Token** from Step 2
    4. Review the **Event Configuration**. The defaults are sensible (see [Events sent to TikTok](#events-sent-to-tiktok) below)
    5. Click **Create**

    <div className="mx-auto max-w-md">
            <img alt="OnlyFans API dashboard: Add Tracking Pixel dialog with TikTok Ads selected" src={__img5} placeholder="blur" />
    </div>
  </Step>

  <Step>
    ### Attach the pixel to your Smart Link

    If you created the pixel from the **Ad Platforms** page rather than inline, attach it to the Smart Link using the **Ad Platforms** selector on the Smart Link. You can connect more than one pixel to a single link.

    <div className="mx-auto max-w-md">
            <img alt="OnlyFans API dashboard: TikTok pixel attached via the Ad Platforms selector" src={__img6} placeholder="blur" />
    </div>
  </Step>

  <Step>
    ### Send a test event

    In TikTok Ads Manager, open your pixel's **Test Events** tab and copy the **test event code**.

    Back in the OnlyFans API Dashboard, open the **Send Test Event** dialog on your pixel, pick an **Event**, paste the **Test Event Code**, and send it. Then check the **Test Events** tab in TikTok, where your event should appear within a few minutes.

    <div className="mx-auto max-w-md">
            <img alt="OnlyFans API dashboard: Send Test Event dialog with a test event code" src={__img7} placeholder="blur" />
    </div>

    <Callout>
      Events sent with a test event code don't affect your live data. They're only for verifying the connection. The Test Event Code is **required** for TikTok.
    </Callout>
  </Step>

  <Step>
    ### Use the Smart Link in your TikTok ad

    In TikTok Ads Manager, set your ad's **Destination URL** to your Smart Link, appending TikTok's click-ID macro so conversions can be matched back to the click:

    ```text
    https://trk.of-traffic.com/go/YOUR_SMART_LINK_ID?ttclid=__CLICKID__
    ```

    Replace `YOUR_SMART_LINK_ID` with the ID from your Smart Links dashboard. TikTok replaces `__CLICKID__` with the click's `ttclid` at click time, and Smart Links reads it straight from the `ttclid` parameter and sends it back to TikTok with every conversion. Keep `?ttclid=__CLICKID__` on the URL, since that's the parameter Smart Links uses for TikTok attribution.
  </Step>

  <Step>
    ### Verify conversions are flowing

    Once your ads are live:

    * **Smart Links dashboard**: you should see clicks, subscribers, and revenue
    * **TikTok Events Manager**: conversion events appearing on your pixel
    * **TikTok Ads Manager**: the campaign's **Conversions** column filling in
  </Step>
</Steps>

## Events sent to TikTok

Smart Links can send the following events to your TikTok Pixel. Each one maps to a TikTok event in the **Event Configuration** section when you add the pixel. These are the defaults, and every event is configurable (map it to any TikTok standard event, a custom event, or turn it off).

| Smart Link event              | When it fires                                             | TikTok event (default) |
| ----------------------------- | --------------------------------------------------------- | ---------------------- |
| **Click**                     | Fan clicks the Smart Link and is redirected to OnlyFans   | `ViewContent`          |
| **New Subscriber**            | Fan subscribes through the Smart Link                     | `Subscribe`            |
| **First Purchase**            | Fan's first non-subscription transaction (tip, PPV, etc.) | `CompletePayment`      |
| **Repeat Purchase**           | Any transaction after the first                           | `CompletePayment`      |
| **Message Received from Fan** | Fan sends a message after converting                      | *Not sent by default*  |
| **Fan Sent 3+ Messages**      | Fan reaches their 3rd inbound message                     | *Not sent by default*  |

<Callout type="info">
  For subscriber and purchase events, Smart Links also sends the conversion **value** and **currency** when available, so TikTok can optimize toward your highest-value fans, not just any conversion.
</Callout>

## Troubleshooting

| Problem                                         | Fix                                                                                                                                                            |
| ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| No events showing in TikTok                     | Double-check you pasted **both** the Pixel ID and the Access Token. TikTok's server-side Events API needs both to authenticate.                                |
| Test event never appears                        | A **Test Event Code** is required for TikTok. Copy it from your pixel's **Test Events** tab and paste it into the Send Test Event dialog. Allow a few minutes. |
| Events arrive but the campaign isn't optimizing | Set your ad group's optimization goal to the matching conversion event (e.g. `CompletePayment` or `Subscribe`).                                                |
| High traffic but low conversions                | TikTok traffic is high-volume. Give the pixel **50+ conversions** before judging so the algorithm has enough data to learn from.                               |

# Uploading media (/introduction/guides/uploading-media)

OnlyFans API makes it really easy to include photos and videos in your posts and messages. You can upload media files directly to our API, and then reference them in our relevant endpoints.

## Prepare the relevant photo, video or audio

* If you want to use a new photo or video, you may upload it to our API.
* Alternatively, if you want to use a photo or video from your Vault, you may reference its ID directly in the relevant endpoints.

### Upload your photo or video to our API

<Callout>
  The full media upload endpoint documentation can be found
  [here](/api-reference/media/upload-media-to-the-only-fans-cdn).
</Callout>

Submit a POST request to our `https://app.onlyfansapi.com/api/{account}/media/upload` endpoint. You can upload media in one of two ways:

1. **File upload** — send the file directly as a multipart form upload using the `file` field.
2. **URL upload** — provide a `file_url` field containing an HTTPS URL pointing to the media file. Our server will download it and upload it to the OnlyFans CDN on your behalf. This is useful when the media already exists at a remote URL and you want to avoid downloading it locally first.

<Callout type="warn">
  You must provide **exactly one** of `file` or `file_url` — not both, and not neither. Providing both or neither will result in a `422` validation error.
</Callout>

<Callout>
  The maximum file size for `file` (direct upload) is **100 MB** - this is limited by Cloudflare. The maximum file size for `file_url` (Remote URL upload) is **1 GB**. Need higher limits? Contact us for enterprise options via [Telegram](https://t.me/onlyfansapi) or [email](mailto:hello@onlyfansapi.com?subject=Need%20my%20Media%20Upload%20File%20Size%20Limit%20Increased).
</Callout>

#### Option 1: Upload a file directly

<CodeBlockTabs defaultValue="cURL">
  <CodeBlockTabsList>
    <CodeBlockTabsTrigger value="cURL">
      cURL
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="JavaScript (Fetch)">
      JavaScript (Fetch)
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="Node.js (Axios)">
      Node.js (Axios)
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="PHP (Guzzle)">
      PHP (Guzzle)
    </CodeBlockTabsTrigger>
  </CodeBlockTabsList>

  <CodeBlockTab value="cURL">
    ```bash
    curl --location 'https://app.onlyfansapi.com/api/{account}/media/upload' \
         --header 'Authorization: Bearer {token}' \
         --form 'file=@"/Users/me/Documents/MyVideo.mp4"'
    ```
  </CodeBlockTab>

  <CodeBlockTab value="JavaScript (Fetch)">
    ```ts
    const myHeaders = new Headers();
    myHeaders.append("Authorization", "Bearer {token}");

    const formdata = new FormData();
    formdata.append("file", fileInput.files[0], "MyVideo.mp4");

    const requestOptions = {
      method: "POST",
      headers: myHeaders,
      body: formdata,
      redirect: "follow",
    };

    fetch("https://app.onlyfansapi.com/api/{account}/media/upload", requestOptions)
      .then((response) => response.text())
      .then((result) => console.log(result))
      .catch((error) => console.error(error));
    ```
  </CodeBlockTab>

  <CodeBlockTab value="Node.js (Axios)">
    ```js
    const axios = require("axios");
    const FormData = require("form-data");
    const fs = require("fs");
    let data = new FormData();
    data.append("file", fs.createReadStream("/Users/me/Documents/MyVideo.mp4"));

    let config = {
      method: "post",
      maxBodyLength: Infinity,
      url: "https://app.onlyfansapi.com/api/{account}/media/upload",
      headers: {
        Authorization: "Bearer {token}",
        ...data.getHeaders()
      },
      data: data
    };

    axios
      .request(config)
      .then((response) => {
        console.log(JSON.stringify(response.data));
      })
      .catch((error) => {
        console.log(error);
      });
    ```
  </CodeBlockTab>

  <CodeBlockTab value="PHP (Guzzle)">
    ```php
    $client = new Client();

    $headers = [
        'Authorization' => 'Bearer {token}'
    ];

    $options = [
        'multipart' => [
        [
            'name' => 'file',
            'contents' => Utils::tryFopen('/Users/me/Documents/MyVideo.mp4', 'r'),
            'filename' => '/Users/me/Documents/MyVideo.mp4',
        ]
    ]];

    $request = new Request('POST', 'https://app.onlyfansapi.com/api/{account}/media/upload', $headers);

    $res = $client->sendAsync($request, $options)->wait();

    echo $res->getBody();
    ```
  </CodeBlockTab>
</CodeBlockTabs>

#### Option 2: Upload from a URL

If your media is already hosted at a remote URL, you can pass it via `file_url` instead of uploading the file directly:

<CodeBlockTabs defaultValue="cURL">
  <CodeBlockTabsList>
    <CodeBlockTabsTrigger value="cURL">
      cURL
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="JavaScript (Fetch)">
      JavaScript (Fetch)
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="Node.js (Axios)">
      Node.js (Axios)
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="PHP (Guzzle)">
      PHP (Guzzle)
    </CodeBlockTabsTrigger>
  </CodeBlockTabsList>

  <CodeBlockTab value="cURL">
    ```bash
    curl -X POST 'https://app.onlyfansapi.com/api/{account}/media/upload' \
         -H 'Authorization: Bearer {token}' \
         -H 'Content-Type: application/json' \
         -d '{"file_url": "https://example.com/media/photo.jpg"}'
    ```
  </CodeBlockTab>

  <CodeBlockTab value="JavaScript (Fetch)">
    ```ts
    const response = await fetch(
      "https://app.onlyfansapi.com/api/{account}/media/upload",
      {
        method: "POST",
        headers: {
          Authorization: "Bearer {token}",
          "Content-Type": "application/json",
        },
        body: JSON.stringify({
          file_url: "https://example.com/media/photo.jpg",
        }),
      }
    );

    const result = await response.json();
    console.log(result);
    ```
  </CodeBlockTab>

  <CodeBlockTab value="Node.js (Axios)">
    ```js
    const axios = require("axios");

    let config = {
      method: "post",
      url: "https://app.onlyfansapi.com/api/{account}/media/upload",
      headers: {
        Authorization: "Bearer {token}",
        "Content-Type": "application/json",
      },
      data: {
        file_url: "https://example.com/media/photo.jpg",
      },
    };

    axios
      .request(config)
      .then((response) => {
        console.log(JSON.stringify(response.data));
      })
      .catch((error) => {
        console.log(error);
      });
    ```
  </CodeBlockTab>

  <CodeBlockTab value="PHP (Guzzle)">
    ```php
    $client = new Client();

    $headers = [
        'Authorization' => 'Bearer {token}',
        'Content-Type' => 'application/json',
    ];

    $body = json_encode([
        'file_url' => 'https://example.com/media/photo.jpg',
    ]);

    $request = new Request('POST', 'https://app.onlyfansapi.com/api/{account}/media/upload', $headers, $body);

    $res = $client->sendAsync($request)->wait();

    echo $res->getBody();
    ```
  </CodeBlockTab>
</CodeBlockTabs>

**If the upload was successful, the response will be something as follows:**

```json
{
  "prefixed_id": "ofapi_media_123",
  "file_name": "MyVideo.mp4",
  "processId": "abc123",
  "host": "convert1.onlyfans.com",
  "sourceUrl": "https://of2transcoder.s3.amazonaws.com/upload/xxx/xxx/MyVideo.mp4?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=xxx&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=xxx&X-Amz-Date=xxx&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Signature=xxx",
  "extra": "xxx",
  "additional": {
    "user": "169224851"
  },
  "thumbs": [
    {
      "id": 1,
      "url": "https://cdn2.onlyfans.com/files/f/f0/xxx/300x300_xxx.jpg?Expires=xxx&Signature=xxx&Key-Pair-Id=xxx"
    }
  ],
  "note": "Maximum file size is 1 GB. Need higher limits? Contact us for enterprise options."
}
```

You may use the `prefixed_id` (e.g., `ofapi_media_123`) in our relevant endpoints to include this media file.

<Callout type="warn">
  **Important!**

  The `prefixed_id` from the above request can only be used **once**. After you use it in a post or message, it will no longer be valid for future use. If you want to reuse the same media file, you must upload it again to get a new `prefixed_id`.
</Callout>

<Callout type="warn">
  **Important for files over 50 MB!**

  We STRONGLY recommend uploading large files (either from `file_url` or `file`) to use the `async=true` body parameter.

  This will result in a much faster and more reliable upload process as we handle the uploading in the background.

  Please refer to docs for:

  * [Upload Media to OnlyFans CDN](/api-reference/media/upload-media-to-the-only-fans-cdn)
  * [Upload Media to OnlyFans Vault](/api-reference/media-vault/upload-media-to-vault)
  * [Get Upload Status (Polling)](/api-reference/media/get-upload-status)
</Callout>

### Validation rules

| Scenario                                              | Result      |
| ----------------------------------------------------- | ----------- |
| `file` provided, no `file_url`                        | Valid       |
| `file_url` provided, no `file`                        | Valid       |
| Both provided                                         | `422` error |
| Neither provided                                      | `422` error |
| File in `file` exceeds 100 MB (limited by Cloudflare) | `422` error |
| File in `file_url` exceeds 1 GB                       | `422` error |

## Code examples

This tutorial walks through uploading **images**, **videos**, or **audio** into your **OnlyFans vault** with the API, then sending a **chat message** with that media attached. Vault uploads use **`POST`** `https://app.onlyfansapi.com/api/{account}/media/vault` with **`multipart/form-data`**: send either a `file` part or a `file_url` part (exactly one), and optionally `async` for background processing. See [Upload Media to Vault](/api-reference/media-vault/upload-media-to-vault) for full payloads and responses.

The snippets below are **Node.js** (TypeScript) using global **`fetch`** (**Node 18+**). Install **`form-data`** for multipart vault uploads (`npm install form-data`). Streaming multipart bodies require **`duplex: "half"`** on the fetch options (shown in the examples). For TypeScript, add **`npm install -D @types/node`**.

### Direct multipart upload

<Callout>
  The maximum size for direct multipart `file` uploads is **100 MB**, enforced by **Cloudflare**. For larger files, use `file_url` and/or `async=true` (see below).
</Callout>

Synchronous vault upload returns **`200`** with the new vault item under `data` (use `data.id` as the vault media ID).

```ts
import FormData from "form-data";
import { createReadStream } from "node:fs";
import { basename } from "node:path";

const BASE = "https://app.onlyfansapi.com";
const account = "acct_XXXXXXXXXXXXXXX";
const apiKey = "ofapi_XXXXXXXXXXXXXXXXXXXXXXXXXXXX";

async function uploadVaultFromFile(filePath: string): Promise<number> {
  const form = new FormData();
  form.append("file", createReadStream(filePath), basename(filePath));

  const res = await fetch(`${BASE}/api/${account}/media/vault`, {
    method: "POST",
    headers: {
      Authorization: `Bearer ${apiKey}`,
      ...form.getHeaders(),
    },
    body: form as unknown as BodyInit,
    duplex: "half",
  } as RequestInit & { duplex: "half" });

  if (!res.ok) throw new Error(await res.text());
  const json = (await res.json()) as { data: { id: number } };
  return json.data.id;
}

// Example: upload a local audio/video/image file
// const vaultId = await uploadVaultFromFile("/path/to/clip.mp4");
```

### Upload from a remote URL, then send a chat message

After a **synchronous** vault upload, the vault media ID is `data.id`. Attach it with [Send Message](/api-reference/chat-messages/send-message) using `mediaFiles`.

```ts
import FormData from "form-data";

const BASE = "https://app.onlyfansapi.com";
const account = "acct_XXXXXXXXXXXXXXX";
const apiKey = "ofapi_XXXXXXXXXXXXXXXXXXXXXXXXXXXX";
const chatId = "123456789"; // fan / chat id from List Chats

async function uploadVaultFromUrl(fileUrl: string): Promise<number> {
  const form = new FormData();
  form.append("file_url", fileUrl);

  const res = await fetch(`${BASE}/api/${account}/media/vault`, {
    method: "POST",
    headers: {
      Authorization: `Bearer ${apiKey}`,
      ...form.getHeaders(),
    },
    body: form as unknown as BodyInit,
    duplex: "half",
  } as RequestInit & { duplex: "half" });

  if (!res.ok) throw new Error(await res.text());
  const json = (await res.json()) as { data: { id: number } };
  return json.data.id;
}

async function sendMessageWithVaultMedia(vaultMediaId: number) {
  const res = await fetch(`${BASE}/api/${account}/chats/${chatId}/messages`, {
    method: "POST",
    headers: {
      Authorization: `Bearer ${apiKey}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      text: "Here is the media you asked for.",
      mediaFiles: [vaultMediaId],
    }),
  });
  if (!res.ok) throw new Error(await res.text());
  return res.json();
}

async function exampleUrlUploadThenMessage() {
  const vaultId = await uploadVaultFromUrl("https://example.com/media/photo.jpg");
  await sendMessageWithVaultMedia(vaultId);
}
```

### (Recommended) Upload asynchronously, then poll until complete, then message

<Callout type="warn">
  For **files over \~50 MB**, prefer **`async=true`**: the upload runs in the background and you poll for completion instead of holding one long HTTP request that might timeout. See [Get Upload Status](/api-reference/media/get-upload-status) for statuses (`pending`, `processing`, `completed`, `failed`).
</Callout>

With **`async=true`**, the API responds with **`202`** and a `polling_url`. Poll that URL (no extra credits) until `status` is `completed` or `failed`. On success, use **`prefixed_id`** (`ofapi_media_…`) and/or **`media.id`** in `mediaFiles`.

```ts
import FormData from "form-data";
import { createReadStream } from "node:fs";
import { basename } from "node:path";

const BASE = "https://app.onlyfansapi.com";
const account = "acct_XXXXXXXXXXXXXXX";
const apiKey = "ofapi_XXXXXXXXXXXXXXXXXXXXXXXXXXXX";
const chatId = "123456789";

type UploadStatus =
  | { status: "pending" | "processing"; prefixed_id: string }
  | { status: "failed"; prefixed_id: string; error: string }
  | {
      status: "completed";
      prefixed_id: string;
      media: { id: number };
      credits_used?: number;
    };

type AsyncStart = {
  status: string;
  prefixed_id: string;
  polling_url: string;
};

async function uploadVaultAsync(opts: {
  filePath?: string;
  file_url?: string;
}): Promise<AsyncStart> {
  const form = new FormData();
  form.append("async", "true");
  if (opts.file_url) form.append("file_url", opts.file_url);
  else if (opts.filePath)
    form.append("file", createReadStream(opts.filePath), basename(opts.filePath));
  else throw new Error("Provide filePath or file_url");

  const res = await fetch(`${BASE}/api/${account}/media/vault`, {
    method: "POST",
    headers: {
      Authorization: `Bearer ${apiKey}`,
      ...form.getHeaders(),
    },
    body: form as unknown as BodyInit,
    duplex: "half",
  } as RequestInit & { duplex: "half" });

  if (res.status !== 202) {
    throw new Error(await res.text());
  }
  return (await res.json()) as AsyncStart;
}

type CompletedUpload = Extract<UploadStatus, { status: "completed" }>;

async function waitForUploadComplete(
  pollingUrl: string,
  opts?: { intervalMs?: number }
): Promise<CompletedUpload> {
  const interval = opts?.intervalMs ?? 2000;
  for (;;) {
    const res = await fetch(pollingUrl, {
      headers: { Authorization: `Bearer ${apiKey}` },
    });
    if (!res.ok) throw new Error(await res.text());
    const body = (await res.json()) as UploadStatus;

    if (body.status === "completed") return body;
    if (body.status === "failed")
      throw new Error(body.error ?? "Upload failed");

    await new Promise((r) => setTimeout(r, interval));
  }
}

async function sendMessageWithPrefixedOrVaultId(done: CompletedUpload) {
  const res = await fetch(`${BASE}/api/${account}/chats/${chatId}/messages`, {
    method: "POST",
    headers: {
      Authorization: `Bearer ${apiKey}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      text: "Large file is ready.",
      // `prefixed_id` or `media.id` — both are accepted in mediaFiles
      mediaFiles: [done.prefixed_id],
    }),
  });
  if (!res.ok) throw new Error(await res.text());
  return res.json();
}

// Example: async from remote URL (good for large files)
async function exampleAsyncVaultThenMessage() {
  const started = await uploadVaultAsync({
    file_url: "https://example.com/media/large-video.mp4",
  });
  const done = await waitForUploadComplete(started.polling_url);
  await sendMessageWithPrefixedOrVaultId(done);
}

// Example: async from a local file path
async function exampleAsyncLocalFileThenMessage() {
  const started = await uploadVaultAsync({
    filePath: "/path/to/large-video.mp4",
  });
  const done = await waitForUploadComplete(started.polling_url);
  await sendMessageWithPrefixedOrVaultId(done);
}
```

## Including your media in a new post

<Callout>
  The full send post endpoint documentation can be found
  [here](/api-reference/posts/send-post).
</Callout>

Once you have retrieved the correct media IDs (either from the upload response, or from your Vault), you can include them in your post:

```json Example request body
{
  "text": "The text of your post",
  "mediaFiles": ["ofapi_media_123", "1234567890"]
}
```

## Including your media in a chat message

<Callout>
  The full send chat message endpoint documentation can be found
  [here](/api-reference/chat-messages/send-message).
</Callout>

Once you have retrieved the correct media IDs (either from the upload response, or from your Vault), you can include them in your message:

```json Example request body
{
  "text": "The text of your message",
  "mediaFiles": ["ofapi_media_123", "1234567890"]
}
```

## Media file array options

You can include two different types of IDs in the `mediaFiles` array:

1. An OnlyFans API ID starting with `ofapi_media_`. This needs to be the `prefixed_id` of the media file we just uploaded.

   <Callout type="warn">
     **Important! The `ofapi_media_` ID from a media file upload can only be used once.**

     After you use it in a post or message, it will no longer be valid for future use. To use the media again, you must use the OnlyFans Vault Media ID.
   </Callout>

2. An OnlyFans Vault Media ID like `1234567890`. This is the OnlyFans ID of a media file that already exists in the Vault. Use our [List Vault Media](api-reference/media-vault/list-vault-media) endpoint to retrieve this ID.

## Demo video

<Card>
  <iframe src="https://cap.link/gynx4e5rjtt996q" width="100%" height="400px" frameBorder="0" title="OnlyFans API Media Upload tutorial" allowFullScreen />
</Card>

# OnlyFans API Overview (/api-reference/overview)

import {
  BanknoteArrowDownIcon,
  BotMessageSquareIcon,
  ChartSplineIcon,
  GalleryVerticalEndIcon,
  ImageDownIcon,
  ImageIcon,
  ImageUpIcon,
  MessageSquareReplyIcon,
  MessageSquareTextIcon,
  MessagesSquareIcon,
  RocketIcon,
  ScrollTextIcon,
  SendIcon,
  SmilePlusIcon,
  UserCheckIcon,
  UserSearchIcon,
  UsersIcon,
  UserXIcon,
} from "lucide-react";

## Not sure where to start?

Browse our frequently used API endpoints below to get a feel for what's possible with OnlyFans API.

<Callout title="Wondering which fields come from OnlyFans vs. OFAPI?">
  Some endpoints pass OnlyFans data straight through, others enrich it with fields from our database, and some are computed entirely on our side. See [Endpoint data sources](/introduction/essentials/endpoint-data-sources) for the full breakdown.
</Callout>

## Chats & Messages \[!toc]

<Cards>
  <Card icon={<MessagesSquareIcon />} href="/api-reference/chats/list-chats" title="List Chats">
    Retrieve the latest chats, including details like last message and fan details.
  </Card>

  <Card icon={<MessageSquareTextIcon />} href="/api-reference/chat-messages/list-chat-messages" title="List Chat Messages">
    Retrieve messages from a specific chat.
  </Card>

  <Card icon={<MessageSquareReplyIcon />} href="/api-reference/chat-messages/send-message" title="Send Message">
    Send a new chat message to a fan, including support for media and PPVs.
  </Card>

  <Card icon={<SendIcon />} href="/api-reference/mass-messaging/send-mass-message" title="Send Mass Message">
    Send or schedule a mass message to collections or individual fans, including support for media and PPVs.
  </Card>
</Cards>

## Payouts & Earnings \[!toc]

<Cards className="grid grid-cols-3 gap-4 @container">
  <Card icon={<ChartSplineIcon />} href="/api-reference/payouts/get-earning-statistics" title="Earning Statistics">
    Get a summary of model earnings over time, including totals and breakdowns.
  </Card>

  <Card icon={<ScrollTextIcon />} href="/api-reference/transactions/list-transactions" title="List Transactions (Earnings)">
    Get a list of earning transactions, including details like amount, type, and fan info.
  </Card>

  <Card icon={<BanknoteArrowDownIcon />} href="/api-reference/payouts/request-manual-withdrawal" title="Request Manual Withdrawal">
    Initiate a manual withdrawal, perfect for automating daily payouts.
  </Card>
</Cards>

## Fans & Subscribers \[!toc]

<Cards>
  <Card icon={<UsersIcon />} href="/api-reference/fans/list-all-fans" title="List All Fans">
    Retrieve a list of all fans, and filter by online, total spendings, duration, and more.
  </Card>

  <Card icon={<UserCheckIcon />} href="/api-reference/fans/list-active-fans" title="List Active Fans">
    Get a list of fans who have an active subscription.
  </Card>

  <Card icon={<UserXIcon />} href="/api-reference/fans/list-expired-fans" title="List Expired Fans">
    Get a list of fans whose subscriptions have expired.
  </Card>

  <Card icon={<UserSearchIcon />} href="/api-reference/fans/list-latest-fans" title="List Latest Fans">
    Get a list of fans within a specific date range.
  </Card>
</Cards>

## Media & Vault \[!toc]

<Cards>
  <Card icon={<ImageIcon />} href="/api-reference/media-vault/list-vault-media" title="List Vault Media">
    Retrieve a list of all fans, and filter by online, total spendings, duration, and more.
  </Card>

  <Card icon={<GalleryVerticalEndIcon />} href="/api-reference/media-vault-lists/list-vault-lists" title="List Vault Lists">
    Get a list of fans who have an active subscription.
  </Card>

  <Card icon={<ImageUpIcon />} href="/api-reference/media/upload-media-to-the-only-fans-cdn" title="Upload media to OnlyFans">
    Upload an image, video or audio file to the OnlyFans CDN to include in a message or post.
  </Card>

  <Card icon={<ImageDownIcon />} href="/api-reference/media/download-media-from-the-only-fans-cdn" title="Download media from OnlyFans">
    Download an image, video or audio file from OnlyFans to our own CDN.
  </Card>
</Cards>

<h2 className="text-fd-primary">
  Haven't found what you're looking for?
</h2>

<Cards className="grid grid-cols-3 gap-4 @container">
  <Card icon={<RocketIcon />} title="Explore our full API reference in the sidebar" href="/api-reference">
    We have over 100 endpoints covering most OnlyFans functionality. Check out the sidebar to explore all available endpoints.
  </Card>

  <Card icon={<BotMessageSquareIcon />} title="Ask our AI chatbot">
    Our AI chatbot can help you find the right endpoint for your use case. Click the "Ask AI" button in the bottom right to get started.
  </Card>

  <Card icon={<SmilePlusIcon />} title="Request a new functionality" href="mailto:hello@onlyfansapi.com">
    Need something specific? Let us know! We're constantly adding new endpoints based on user feedback.
  </Card>
</Cards>

# Disconnect Account (/api-reference/fansly/account/disconnect-account)

Disconnect a Fansly account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml delete /api/fansly/accounts/{fanslyAccount}
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/accounts/{fanslyAccount}:
    parameters:
      - in: path
        name: fanslyAccount
        description: ""
        example: rerum
        required: true
        schema:
          type: string
    delete:
      summary: Disconnect Account
      operationId: disconnectAccount
      description: Disconnect a Fansly account.
      parameters: []
      responses:
        "204":
          description: Success
          content:
            application/json:
              schema:
                type: object
                nullable: true
      tags:
        - Account
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Accounts (/api-reference/fansly/account/list-accounts)

List all connected Fansly accounts.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/accounts
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/accounts:
    get:
      summary: List Accounts
      operationId: listAccounts
      description: List all connected Fansly accounts.
      parameters:
        - in: query
          name: fansly_id
          description: Optionally, filter by the Fansly ID
          example: "111222333"
          required: false
          schema:
            type: string
            description: Optionally, filter by the Fansly ID
            example: "111222333"
            nullable: true
        - in: query
          name: fansly_username
          description: Optionally, filter by the Fansly username
          example: username
          required: false
          schema:
            type: string
            description: Optionally, filter by the Fansly username
            example: username
            nullable: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      example: fansly_acct_123
                    display_name:
                      type: string
                      example: My Fansly
                    fansly_id:
                      type: string
                      example: "111222333"
                    fansly_username:
                      type: string
                      example: tester
                    is_authenticated:
                      type: boolean
                      example: true
                    authentication_progress:
                      type: string
                      example: authenticated
                    fansly_user_data:
                      type: object
                      properties:
                        id:
                          type: string
                          example: "111222333"
                        username:
                          type: string
                          example: tester
                        display_name:
                          type: string
                          example: Tester
                        avatar:
                          type: string
                          example: null
                          nullable: true
                example:
                  - id: fansly_acct_123
                    display_name: My Fansly
                    fansly_id: "111222333"
                    fansly_username: tester
                    is_authenticated: true
                    authentication_progress: authenticated
                    fansly_user_data:
                      id: "111222333"
                      username: tester
                      display_name: Tester
                      avatar: null
      tags:
        - Account
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Acknowledge Chat Messages (/api-reference/fansly/chat-messages/acknowledge-chat-messages)

Acknowledge one or more messages. Type 1 = delivered, 2 = read, 3 = read and delivered, 4 = unread. Up to 25 message IDs may be sent per request.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/{fanslyAccount}/chats/{chat_id}/messages/ack
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/chats/{chat_id}/messages/ack:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The Fansly chat (group) ID.
        example: "200000000000000001"
        required: true
        schema:
          type: string
    post:
      summary: Acknowledge Chat Messages
      operationId: acknowledgeChatMessages
      description: Acknowledge one or more messages. Type 1 = delivered, 2 = read, 3 =
        read and delivered, 4 = unread. Up to 25 message IDs may be sent per
        request.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 100000
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: string
                    example: null
                    nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 100000
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Chat Messages
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                messageIds:
                  type: array
                  description: Fansly message IDs to acknowledge.
                  example:
                    - "300000000000000001"
                  items:
                    type: string
                type:
                  type: integer
                  description: "Ack mode: 1 delivered, 2 read, 3 read and delivered, 4 unread."
                  example: 2
                  enum:
                    - 1
                    - 2
                    - 3
                    - 4
              required:
                - messageIds
                - type
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Add Reaction to Chat Message (/api-reference/fansly/chat-messages/add-reaction-to-chat-message)

Add an emoji reaction to a chat message. Multiple reaction types can coexist on a single message.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/{fanslyAccount}/chats/{chat_id}/messages/{message_id}/reactions
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/chats/{chat_id}/messages/{message_id}/reactions:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The Fansly chat (group) ID.
        example: "200000000000000001"
        required: true
        schema:
          type: string
      - in: path
        name: message_id
        description: The Fansly message ID to react to.
        example: "300000000000000001"
        required: true
        schema:
          type: string
    post:
      summary: Add Reaction to Chat Message
      operationId: addReactionToChatMessage
      description: Add an emoji reaction to a chat message. Multiple reaction types
        can coexist on a single message.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    accountId: "100000000000000001"
                    messageId: "300000000000000001"
                    type: 2
                    groupId: "200000000000000001"
                    id: "500000000000000001"
                  _meta:
                    _credits:
                      used: 1
                      balance: 100000
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      accountId:
                        type: string
                        example: "100000000000000001"
                      messageId:
                        type: string
                        example: "300000000000000001"
                      type:
                        type: integer
                        example: 2
                      groupId:
                        type: string
                        example: "200000000000000001"
                      id:
                        type: string
                        example: "500000000000000001"
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 100000
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Chat Messages
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: integer
                  description: "Emoji reaction type: 1 ❤️ heart, 2 😂 laughing, 3 😮 wow, 4 😢
                    cry, 5 🔥 fire, 6 👍 thumbs up, 7 👎 thumbs down."
                  example: 2
                  enum:
                    - 1
                    - 2
                    - 3
                    - 4
                    - 5
                    - 6
                    - 7
              required:
                - type
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Delete Chat Message (/api-reference/fansly/chat-messages/delete-chat-message)

Delete one of your own messages from a chat (messaging group).

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml delete /api/fansly/{fanslyAccount}/chats/{chat_id}/messages/{message_id}
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/chats/{chat_id}/messages/{message_id}:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The Fansly chat (group) ID.
        example: "200000000000000001"
        required: true
        schema:
          type: string
      - in: path
        name: message_id
        description: The Fansly message ID to delete.
        example: "300000000000000001"
        required: true
        schema:
          type: string
    delete:
      summary: Delete Chat Message
      operationId: deleteChatMessage
      description: Delete one of your own messages from a chat (messaging group).
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: "300000000000000001"
                    type: 1
                    dataVersion: 1
                    content: Hey there!
                    groupId: "200000000000000001"
                    senderId: "100000000000000001"
                    correlationId: "0"
                    inReplyTo: null
                    inReplyToRoot: null
                    createdAt: 1700000000
                    attachments: []
                    embeds: []
                    interactions:
                      - userId: "300000000000000001"
                        readAt: 0
                        deliveredAt: 0
                    likes: []
                    deletedAt: 1700000010
                  _meta:
                    _credits:
                      used: 1
                      balance: 100000
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: "300000000000000001"
                      type:
                        type: integer
                        example: 1
                      dataVersion:
                        type: integer
                        example: 1
                      content:
                        type: string
                        example: Hey there!
                      groupId:
                        type: string
                        example: "200000000000000001"
                      senderId:
                        type: string
                        example: "100000000000000001"
                      correlationId:
                        type: string
                        example: "0"
                      inReplyTo:
                        type: string
                        example: null
                        nullable: true
                      inReplyToRoot:
                        type: string
                        example: null
                        nullable: true
                      createdAt:
                        type: integer
                        example: 1700000000
                      attachments:
                        type: array
                        example: []
                      embeds:
                        type: array
                        example: []
                      interactions:
                        type: array
                        example:
                          - userId: "300000000000000001"
                            readAt: 0
                            deliveredAt: 0
                        items:
                          type: object
                          properties:
                            userId:
                              type: string
                              example: "300000000000000001"
                            readAt:
                              type: integer
                              example: 0
                            deliveredAt:
                              type: integer
                              example: 0
                      likes:
                        type: array
                        example: []
                      deletedAt:
                        type: integer
                        example: 1700000010
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 100000
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Chat Messages
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Chat Messages (/api-reference/fansly/chat-messages/list-chat-messages)

Get the messages for a specific chat. The response also includes aggregated content referenced from the messages — `accountMedia`, `accountMediaBundles`, `tips`, `tipGoals`, `accountMediaOrders`, `stories`, `storyOrders`.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/chats/{chat_id}/messages
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/chats/{chat_id}/messages:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The Fansly chat (group) ID.
        example: "200000000000000001"
        required: true
        schema:
          type: string
    get:
      summary: List Chat Messages
      operationId: listChatMessages
      description: Get the messages for a specific chat. The response also includes
        aggregated content referenced from the messages — `accountMedia`,
        `accountMediaBundles`, `tips`, `tipGoals`, `accountMediaOrders`,
        `stories`, `storyOrders`.
      parameters:
        - in: query
          name: limit
          description: Number of messages to return (1 - 100). Default = 25
          example: 25
          required: false
          schema:
            type: string
            description: Number of messages to return (1 - 100). Default = 25
            example: 25
        - in: query
          name: before
          description: Cursor for older messages — the ID of a message you've already
            received. Pass the oldest message ID from the previous page to fetch
            the next page. Leave empty for the most recent messages.
          example: "300000000000000001"
          required: false
          schema:
            type: string
            description: Cursor for older messages — the ID of a message you've already
              received. Pass the oldest message ID from the previous page to
              fetch the next page. Leave empty for the most recent messages.
            example: "300000000000000001"
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    messages:
                      - id: "400000000000000003"
                        type: 1
                        dataVersion: 1
                        content: Message text three
                        groupId: "200000000000000001"
                        senderId: "300000000000000001"
                        correlationId: "400000000000000093"
                        inReplyTo: null
                        inReplyToRoot: null
                        createdAt: 1700000200
                        attachments: []
                        embeds: []
                        interactions:
                          - userId: "100000000000000001"
                            readAt: 1700000200
                            deliveredAt: 1700000200
                        likes: []
                        totalTipAmount: 0
                      - id: "400000000000000002"
                        type: 1
                        dataVersion: 1
                        content: Message text two
                        groupId: "200000000000000001"
                        senderId: "300000000000000001"
                        correlationId: "400000000000000092"
                        inReplyTo: null
                        inReplyToRoot: null
                        createdAt: 1700000100
                        attachments:
                          - messageId: "400000000000000002"
                            contentType: 1
                            contentId: "700000000000000001"
                            pos: 0
                        embeds: []
                        interactions: []
                        likes: []
                        totalTipAmount: 0
                      - id: "400000000000000001"
                        type: 1
                        dataVersion: 1
                        content: Message text one
                        groupId: "200000000000000001"
                        senderId: "300000000000000001"
                        correlationId: "400000000000000091"
                        inReplyTo: null
                        inReplyToRoot: null
                        createdAt: 1700000000
                        attachments: []
                        embeds: []
                        interactions: []
                        likes: []
                        totalTipAmount: 0
                    accountMedia:
                      - id: "700000000000000001"
                        accountId: "300000000000000001"
                        mediaId: "800000000000000001"
                        previewId: null
                        permissionFlags: 0
                        price: 0
                        createdAt: 1700000000
                        deletedAt: null
                        deleted: false
                        permissions:
                          permissionFlags: []
                          accountPermissionFlags:
                            flags: 2
                            metadata: "{}"
                        likeCount: 0
                        media:
                          id: "800000000000000001"
                          type: 1
                          status: 1
                          accountId: "300000000000000001"
                          mimetype: image/jpeg
                          flags: 0
                          location: /300000000000000001/800000000000000001.jpeg
                          width: 1080
                          height: 1440
                          metadata: '{"resolutionMode":2}'
                          updatedAt: 1700000000
                          createdAt: 1700000000
                          variants: []
                          variantHash: {}
                          locations:
                            - locationId: "1"
                              location: https://cdn3.fansly.com/300000000000000001/800000000000000001.jpeg
                        purchased: false
                        whitelisted: false
                        accountPermissionFlags: 2
                        access: true
                    accountMediaBundles: []
                    tips: []
                    tipGoals: []
                    accountMediaOrders: []
                    stories: []
                    storyOrders: []
                    hasMore: false
                  _pagination:
                    next_page: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055812
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      messages:
                        type: array
                        example:
                          - id: "400000000000000003"
                            type: 1
                            dataVersion: 1
                            content: Message text three
                            groupId: "200000000000000001"
                            senderId: "300000000000000001"
                            correlationId: "400000000000000093"
                            inReplyTo: null
                            inReplyToRoot: null
                            createdAt: 1700000200
                            attachments: []
                            embeds: []
                            interactions:
                              - userId: "100000000000000001"
                                readAt: 1700000200
                                deliveredAt: 1700000200
                            likes: []
                            totalTipAmount: 0
                          - id: "400000000000000002"
                            type: 1
                            dataVersion: 1
                            content: Message text two
                            groupId: "200000000000000001"
                            senderId: "300000000000000001"
                            correlationId: "400000000000000092"
                            inReplyTo: null
                            inReplyToRoot: null
                            createdAt: 1700000100
                            attachments:
                              - messageId: "400000000000000002"
                                contentType: 1
                                contentId: "700000000000000001"
                                pos: 0
                            embeds: []
                            interactions: []
                            likes: []
                            totalTipAmount: 0
                          - id: "400000000000000001"
                            type: 1
                            dataVersion: 1
                            content: Message text one
                            groupId: "200000000000000001"
                            senderId: "300000000000000001"
                            correlationId: "400000000000000091"
                            inReplyTo: null
                            inReplyToRoot: null
                            createdAt: 1700000000
                            attachments: []
                            embeds: []
                            interactions: []
                            likes: []
                            totalTipAmount: 0
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: "400000000000000003"
                            type:
                              type: integer
                              example: 1
                            dataVersion:
                              type: integer
                              example: 1
                            content:
                              type: string
                              example: Message text three
                            groupId:
                              type: string
                              example: "200000000000000001"
                            senderId:
                              type: string
                              example: "300000000000000001"
                            correlationId:
                              type: string
                              example: "400000000000000093"
                            inReplyTo:
                              type: string
                              example: null
                              nullable: true
                            inReplyToRoot:
                              type: string
                              example: null
                              nullable: true
                            createdAt:
                              type: integer
                              example: 1700000200
                            attachments:
                              type: array
                              example: []
                            embeds:
                              type: array
                              example: []
                            interactions:
                              type: array
                              example:
                                - userId: "100000000000000001"
                                  readAt: 1700000200
                                  deliveredAt: 1700000200
                              items:
                                type: object
                                properties:
                                  userId:
                                    type: string
                                    example: "100000000000000001"
                                  readAt:
                                    type: integer
                                    example: 1700000200
                                  deliveredAt:
                                    type: integer
                                    example: 1700000200
                            likes:
                              type: array
                              example: []
                            totalTipAmount:
                              type: integer
                              example: 0
                      accountMedia:
                        type: array
                        example:
                          - id: "700000000000000001"
                            accountId: "300000000000000001"
                            mediaId: "800000000000000001"
                            previewId: null
                            permissionFlags: 0
                            price: 0
                            createdAt: 1700000000
                            deletedAt: null
                            deleted: false
                            permissions:
                              permissionFlags: []
                              accountPermissionFlags:
                                flags: 2
                                metadata: "{}"
                            likeCount: 0
                            media:
                              id: "800000000000000001"
                              type: 1
                              status: 1
                              accountId: "300000000000000001"
                              mimetype: image/jpeg
                              flags: 0
                              location: /300000000000000001/800000000000000001.jpeg
                              width: 1080
                              height: 1440
                              metadata: '{"resolutionMode":2}'
                              updatedAt: 1700000000
                              createdAt: 1700000000
                              variants: []
                              variantHash: []
                              locations:
                                - locationId: "1"
                                  location: https://cdn3.fansly.com/300000000000000001/800000000000000001.jpeg
                            purchased: false
                            whitelisted: false
                            accountPermissionFlags: 2
                            access: true
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: "700000000000000001"
                            accountId:
                              type: string
                              example: "300000000000000001"
                            mediaId:
                              type: string
                              example: "800000000000000001"
                            previewId:
                              type: string
                              example: null
                              nullable: true
                            permissionFlags:
                              type: integer
                              example: 0
                            price:
                              type: integer
                              example: 0
                            createdAt:
                              type: integer
                              example: 1700000000
                            deletedAt:
                              type: string
                              example: null
                              nullable: true
                            deleted:
                              type: boolean
                              example: false
                            permissions:
                              type: object
                              properties:
                                permissionFlags:
                                  type: array
                                  example: []
                                accountPermissionFlags:
                                  type: object
                                  properties:
                                    flags:
                                      type: integer
                                      example: 2
                                    metadata:
                                      type: string
                                      example: "{}"
                            likeCount:
                              type: integer
                              example: 0
                            media:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: "800000000000000001"
                                type:
                                  type: integer
                                  example: 1
                                status:
                                  type: integer
                                  example: 1
                                accountId:
                                  type: string
                                  example: "300000000000000001"
                                mimetype:
                                  type: string
                                  example: image/jpeg
                                flags:
                                  type: integer
                                  example: 0
                                location:
                                  type: string
                                  example: /300000000000000001/800000000000000001.jpeg
                                width:
                                  type: integer
                                  example: 1080
                                height:
                                  type: integer
                                  example: 1440
                                metadata:
                                  type: string
                                  example: '{"resolutionMode":2}'
                                updatedAt:
                                  type: integer
                                  example: 1700000000
                                createdAt:
                                  type: integer
                                  example: 1700000000
                                variants:
                                  type: array
                                  example: []
                                variantHash:
                                  type: object
                                  properties: {}
                                locations:
                                  type: array
                                  example:
                                    - locationId: "1"
                                      location: https://cdn3.fansly.com/300000000000000001/800000000000000001.jpeg
                                  items:
                                    type: object
                                    properties:
                                      locationId:
                                        type: string
                                        example: "1"
                                      location:
                                        type: string
                                        example: https://cdn3.fansly.com/300000000000000001/800000000000000001.jpeg
                            purchased:
                              type: boolean
                              example: false
                            whitelisted:
                              type: boolean
                              example: false
                            accountPermissionFlags:
                              type: integer
                              example: 2
                            access:
                              type: boolean
                              example: true
                      accountMediaBundles:
                        type: array
                        example: []
                      tips:
                        type: array
                        example: []
                      tipGoals:
                        type: array
                        example: []
                      accountMediaOrders:
                        type: array
                        example: []
                      stories:
                        type: array
                        example: []
                      storyOrders:
                        type: array
                        example: []
                      hasMore:
                        type: boolean
                        example: false
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: null
                        nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055812
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Chat Messages
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Remove Reaction from Chat Message (/api-reference/fansly/chat-messages/remove-reaction-from-chat-message)

Remove a previously-added emoji reaction from a chat message.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml delete /api/fansly/{fanslyAccount}/chats/{chat_id}/messages/{message_id}/reactions
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/chats/{chat_id}/messages/{message_id}/reactions:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The Fansly chat (group) ID.
        example: "200000000000000001"
        required: true
        schema:
          type: string
      - in: path
        name: message_id
        description: The Fansly message ID to react to.
        example: "300000000000000001"
        required: true
        schema:
          type: string
    delete:
      summary: Remove Reaction from Chat Message
      operationId: removeReactionFromChatMessage
      description: Remove a previously-added emoji reaction from a chat message.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    accountId: "100000000000000001"
                    messageId: "300000000000000001"
                    type: 2
                    id: "500000000000000002"
                    groupId: "200000000000000001"
                  _meta:
                    _credits:
                      used: 1
                      balance: 100000
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      accountId:
                        type: string
                        example: "100000000000000001"
                      messageId:
                        type: string
                        example: "300000000000000001"
                      type:
                        type: integer
                        example: 2
                      id:
                        type: string
                        example: "500000000000000002"
                      groupId:
                        type: string
                        example: "200000000000000001"
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 100000
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Chat Messages
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: integer
                  description: "Emoji reaction type to remove: 1 ❤️ heart, 2 😂 laughing, 3 😮
                    wow, 4 😢 cry, 5 🔥 fire, 6 👍 thumbs up, 7 👎 thumbs down."
                  example: 2
                  enum:
                    - 1
                    - 2
                    - 3
                    - 4
                    - 5
                    - 6
                    - 7
              required:
                - type
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Send Chat Message (/api-reference/fansly/chat-messages/send-chat-message)

Send a new message to a chat (messaging group). Provide `text`, one or more media IDs in `mediaFiles`, or both. Media must first be uploaded via the Upload Media endpoint (use the returned `fansly_media_` ID).

Attached media can be gated with any combination of the `requirePurchase`, `requireSubscription`, and `requireFollow` options (they stack — e.g. a media can require both a subscription and a purchase). The gating applies to all attached media: a single file, or the whole bundle when several are attached. When none of the gating options are sent, media keeps the default visibility.

Any attached media can be given a free preview — a separate media shown unlocked while the paid media is locked — via `previews`, a map of `mediaFiles` handle to preview handle.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/{fanslyAccount}/chats/{chat_id}/messages
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/chats/{chat_id}/messages:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The Fansly chat (group) ID.
        example: "200000000000000001"
        required: true
        schema:
          type: string
    post:
      summary: Send Chat Message
      operationId: sendChatMessage
      description: >-
        Send a new message to a chat (messaging group). Provide `text`, one or
        more media IDs in `mediaFiles`, or both. Media must first be uploaded
        via the Upload Media endpoint (use the returned `fansly_media_` ID).


        Attached media can be gated with any combination of the
        `requirePurchase`, `requireSubscription`, and `requireFollow` options
        (they stack — e.g. a media can require both a subscription and a
        purchase). The gating applies to all attached media: a single file, or
        the whole bundle when several are attached. When none of the gating
        options are sent, media keeps the default visibility.


        Any attached media can be given a free preview — a separate media shown
        unlocked while the paid media is locked — via `previews`, a map of
        `mediaFiles` handle to preview handle.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    type: 1
                    attachments: []
                    content: Hey there!
                    groupId: "200000000000000001"
                    senderId: "100000000000000001"
                    inReplyTo: ""
                    interactions:
                      - groupId: "200000000000000001"
                        userId: "300000000000000001"
                        readAt: 0
                        deliveredAt: 0
                    id: "400000000000000010"
                    createdAt: 1700000000.123
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055811
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      type:
                        type: integer
                        example: 1
                      attachments:
                        type: array
                        example: []
                      content:
                        type: string
                        example: Hey there!
                      groupId:
                        type: string
                        example: "200000000000000001"
                      senderId:
                        type: string
                        example: "100000000000000001"
                      inReplyTo:
                        type: string
                        example: ""
                      interactions:
                        type: array
                        example:
                          - groupId: "200000000000000001"
                            userId: "300000000000000001"
                            readAt: 0
                            deliveredAt: 0
                        items:
                          type: object
                          properties:
                            groupId:
                              type: string
                              example: "200000000000000001"
                            userId:
                              type: string
                              example: "300000000000000001"
                            readAt:
                              type: integer
                              example: 0
                            deliveredAt:
                              type: integer
                              example: 0
                      id:
                        type: string
                        example: "400000000000000010"
                      createdAt:
                        type: number
                        example: 1700000000.123
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055811
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Chat Messages
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: The message text content. Required unless `mediaFiles` is provided.
                  example: Hey there!
                mediaFiles:
                  type: array
                  description: Media to attach, as `fansly_media_` upload IDs returned by the
                    Upload Media endpoint. A single item is sent as one
                    attachment; multiple are grouped into a bundle.
                  example:
                    - fansly_media_01JR1234
                  items:
                    type: string
                replyToMessageId:
                  type: string
                  description: Mark this message as a reply to another message in the chat (either
                    yours or the recipient's).
                  example: "300000000000000001"
                requirePurchase:
                  type: boolean
                  description: Require the fan to purchase (unlock) the attached media. Requires
                    `price`. Combinable with `requireSubscription` /
                    `requireFollow`.
                  example: false
                price:
                  type: integer
                  description: Unlock price for `requirePurchase`, in Fansly's smallest unit —
                    1000 = $1.00 (e.g. 10000 = $10.00). Required when
                    `requirePurchase` is true.
                  example: 10000
                requireSubscription:
                  type: boolean
                  description: Require the fan to be subscribed to view the attached media.
                    Combinable with `requirePurchase` / `requireFollow`.
                  example: false
                subscriptionTierId:
                  type: string
                  description: Restrict `requireSubscription` to a single subscription tier. Tier
                    IDs come from the List Subscription Tiers endpoint. Omit for
                    any tier.
                  example: "843584256474116096"
                requireFollow:
                  type: boolean
                  description: Require the fan to follow the account to view the attached media.
                    Combinable with `requirePurchase` / `requireSubscription`.
                  example: false
                previews:
                  type: object
                  description: Free previews for attached media, as a map of a `mediaFiles` handle
                    to a `fansly_media_` preview upload. Each preview is shown
                    unlocked while its (gated) media is locked. Only include
                    media that should have a preview.
                  example:
                    fansly_media_01JR1234: fansly_media_01JR5678
                  properties: {}
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Create Chat (/api-reference/fansly/chats/create-chat)

Start a new chat (messaging group) with a Fansly user. Returns the created chat, including its `id` to use with the message endpoints. If a chat with this user already exists, Fansly returns the existing one.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/{fanslyAccount}/chats
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/chats:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Create Chat
      operationId: createChat
      description: Start a new chat (messaging group) with a Fansly user. Returns the
        created chat, including its `id` to use with the message endpoints. If a
        chat with this user already exists, Fansly returns the existing one.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    users:
                      - userId: "800000000000000001"
                        permissionFlags: 65535
                        userSettings:
                          hidden: 1
                        groupId: "200000000000000010"
                      - userId: "800000000000000002"
                        permissionFlags: 65535
                        userSettings:
                          hidden: 1
                        groupId: "200000000000000010"
                        dmPermissionFlags:
                          - id: "200000000000000020"
                            accountId: "800000000000000002"
                            type: 0
                            flags: 2
                            metadata: ""
                            verificationFlags: 0
                            verificationMetadata: "{}"
                          - id: "200000000000000021"
                            accountId: "800000000000000002"
                            type: 0
                            flags: 4
                            metadata: '{"4":"{\"subscriptionTierId\":\"\"}"}'
                            verificationFlags: 0
                            verificationMetadata: '{"4":"{\"errors\":[]}"}'
                    recipients: []
                    lastMessage: null
                    userSettings: null
                    type: 1
                    createdBy: "800000000000000001"
                    groupFlagsMetadata: ""
                    id: "200000000000000010"
                    permissionFlags: []
                    hasDmPermissionFlags: false
                    dmPermissionFlags:
                      - id: "200000000000000020"
                        accountId: "800000000000000002"
                        type: 0
                        flags: 2
                        metadata: ""
                        verificationFlags: 0
                        verificationMetadata: "{}"
                      - id: "200000000000000021"
                        accountId: "800000000000000002"
                        type: 0
                        flags: 4
                        metadata: '{"4":"{\"subscriptionTierId\":\"\"}"}'
                        verificationFlags: 0
                        verificationMetadata: '{"4":"{\"errors\":[]}"}'
                    accountDmPermissionFlags:
                      flags: 0
                      metadata: "{}"
                  _meta:
                    _credits:
                      used: 1
                      balance: 100000
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      users:
                        type: array
                        example:
                          - userId: "800000000000000001"
                            permissionFlags: 65535
                            userSettings:
                              hidden: 1
                            groupId: "200000000000000010"
                          - userId: "800000000000000002"
                            permissionFlags: 65535
                            userSettings:
                              hidden: 1
                            groupId: "200000000000000010"
                            dmPermissionFlags:
                              - id: "200000000000000020"
                                accountId: "800000000000000002"
                                type: 0
                                flags: 2
                                metadata: ""
                                verificationFlags: 0
                                verificationMetadata: "{}"
                              - id: "200000000000000021"
                                accountId: "800000000000000002"
                                type: 0
                                flags: 4
                                metadata: '{"4":"{\"subscriptionTierId\":\"\"}"}'
                                verificationFlags: 0
                                verificationMetadata: '{"4":"{\"errors\":[]}"}'
                        items:
                          type: object
                          properties:
                            userId:
                              type: string
                              example: "800000000000000001"
                            permissionFlags:
                              type: integer
                              example: 65535
                            userSettings:
                              type: object
                              properties:
                                hidden:
                                  type: integer
                                  example: 1
                            groupId:
                              type: string
                              example: "200000000000000010"
                      recipients:
                        type: array
                        example: []
                      lastMessage:
                        type: string
                        example: null
                        nullable: true
                      userSettings:
                        type: string
                        example: null
                        nullable: true
                      type:
                        type: integer
                        example: 1
                      createdBy:
                        type: string
                        example: "800000000000000001"
                      groupFlagsMetadata:
                        type: string
                        example: ""
                      id:
                        type: string
                        example: "200000000000000010"
                      permissionFlags:
                        type: array
                        example: []
                      hasDmPermissionFlags:
                        type: boolean
                        example: false
                      dmPermissionFlags:
                        type: array
                        example:
                          - id: "200000000000000020"
                            accountId: "800000000000000002"
                            type: 0
                            flags: 2
                            metadata: ""
                            verificationFlags: 0
                            verificationMetadata: "{}"
                          - id: "200000000000000021"
                            accountId: "800000000000000002"
                            type: 0
                            flags: 4
                            metadata: '{"4":"{\"subscriptionTierId\":\"\"}"}'
                            verificationFlags: 0
                            verificationMetadata: '{"4":"{\"errors\":[]}"}'
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: "200000000000000020"
                            accountId:
                              type: string
                              example: "800000000000000002"
                            type:
                              type: integer
                              example: 0
                            flags:
                              type: integer
                              example: 2
                            metadata:
                              type: string
                              example: ""
                            verificationFlags:
                              type: integer
                              example: 0
                            verificationMetadata:
                              type: string
                              example: "{}"
                      accountDmPermissionFlags:
                        type: object
                        properties:
                          flags:
                            type: integer
                            example: 0
                          metadata:
                            type: string
                            example: "{}"
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 100000
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Chats
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                user_id:
                  type: string
                  description: ""
                  example: velit
              required:
                - user_id
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Disable Chat Read Receipts (/api-reference/fansly/chats/disable-chat-read-receipts)

Disable sending read receipts for a specific Fansly chat.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/{fanslyAccount}/chats/{chat_id}/read-receipts/disable
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/chats/{chat_id}/read-receipts/disable:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The Fansly chat (group) ID.
        example: "200000000000000001"
        required: true
        schema:
          type: string
    post:
      summary: Disable Chat Read Receipts
      operationId: disableChatReadReceipts
      description: Disable sending read receipts for a specific Fansly chat.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    groupId: "200000000000000001"
                    userId: "800000000000000001"
                    sendReadReceipts: 1
                    updatedAt: 1700000000000
                  _meta:
                    _credits:
                      used: 1
                      balance: 100000
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      groupId:
                        type: string
                        example: "200000000000000001"
                      userId:
                        type: string
                        example: "800000000000000001"
                      sendReadReceipts:
                        type: integer
                        example: 1
                      updatedAt:
                        type: integer
                        example: 1700000000000
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 100000
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Chats
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Enable Chat Read Receipts (/api-reference/fansly/chats/enable-chat-read-receipts)

Enable sending read receipts for a specific Fansly chat.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/{fanslyAccount}/chats/{chat_id}/read-receipts/enable
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/chats/{chat_id}/read-receipts/enable:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The Fansly chat (group) ID.
        example: "200000000000000001"
        required: true
        schema:
          type: string
    post:
      summary: Enable Chat Read Receipts
      operationId: enableChatReadReceipts
      description: Enable sending read receipts for a specific Fansly chat.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    groupId: "200000000000000001"
                    userId: "800000000000000001"
                    sendReadReceipts: 2
                    updatedAt: 1700000000000
                  _meta:
                    _credits:
                      used: 1
                      balance: 100000
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      groupId:
                        type: string
                        example: "200000000000000001"
                      userId:
                        type: string
                        example: "800000000000000001"
                      sendReadReceipts:
                        type: integer
                        example: 2
                      updatedAt:
                        type: integer
                        example: 1700000000000
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 100000
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Chats
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Hide Chat (/api-reference/fansly/chats/hide-chat)

Hide a specific chat from the Fansly chat list.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/{fanslyAccount}/chats/{chat_id}/hide
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/chats/{chat_id}/hide:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The Fansly chat (group) ID.
        example: "200000000000000001"
        required: true
        schema:
          type: string
    post:
      summary: Hide Chat
      operationId: hideChat
      description: Hide a specific chat from the Fansly chat list.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    customName: ""
                    hidden: 1
                  _meta:
                    _credits:
                      used: 1
                      balance: 100000
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      customName:
                        type: string
                        example: ""
                      hidden:
                        type: integer
                        example: 1
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 100000
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Chats
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Chats (/api-reference/fansly/chats/list-chats)

Get the list of chats (messaging groups) for a Fansly Account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/chats
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/chats:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Chats
      operationId: listChats
      description: Get the list of chats (messaging groups) for a Fansly Account.
      parameters:
        - in: query
          name: limit
          description: Number of chats to return (1 - 100). Default = 20
          example: 20
          required: false
          schema:
            type: string
            description: Number of chats to return (1 - 100). Default = 20
            example: 20
        - in: query
          name: offset
          description: Number of chats to skip for pagination. Default = 0
          example: 0
          required: false
          schema:
            type: string
            description: Number of chats to skip for pagination. Default = 0
            example: 0
        - in: query
          name: search
          description: Search query to filter chats by partner username/display name
          example: lillie
          required: false
          schema:
            type: string
            description: Search query to filter chats by partner username/display name
            example: lillie
        - in: query
          name: order
          description: Sort order for chats. Default = newest
          example: newest
          required: false
          schema:
            type: string
            description: Sort order for chats. Default = newest
            example: newest
            enum:
              - newest
              - oldest
              - unread
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    data:
                      - account_id: "100000000000000001"
                        groupId: "200000000000000001"
                        partnerAccountId: "300000000000000001"
                        partnerUsername: partner
                        flags: 0
                        unreadCount: 1
                        subscriptionTierId: null
                        lastMessageId: "400000000000000001"
                        lastUnreadMessageId: "400000000000000001"
                    aggregationData:
                      accounts:
                        - id: "300000000000000001"
                          username: partner
                          displayName: Partner
                          flags: 0
                          createdAt: 1700000000000
                          followCount: 0
                          subscriberCount: 0
                          about: About text
                          location: ""
                          following: true
                          avatar:
                            id: "500000000000000001"
                            type: 1
                            mimetype: image/jpeg
                            locations:
                              - locationId: "1"
                                location: https://cdn3.fansly.com/300000000000000001/500000000000000001.jpeg
                      groups:
                        - id: "200000000000000001"
                          type: 1
                          groupFlags: 0
                          createdBy: "300000000000000001"
                          users:
                            - groupId: "200000000000000001"
                              userId: "300000000000000001"
                              type: 0
                              permissionFlags: 65535
                            - groupId: "200000000000000001"
                              userId: "100000000000000001"
                              type: 0
                              permissionFlags: 65535
                          lastMessage:
                            id: "400000000000000001"
                            type: 1
                            content: Message text
                            groupId: "200000000000000001"
                            senderId: "300000000000000001"
                            createdAt: 1700000000
                            attachments: []
                            embeds: []
                    hasMore: false
                  _pagination:
                    next_page: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055812
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      data:
                        type: array
                        example:
                          - account_id: "100000000000000001"
                            groupId: "200000000000000001"
                            partnerAccountId: "300000000000000001"
                            partnerUsername: partner
                            flags: 0
                            unreadCount: 1
                            subscriptionTierId: null
                            lastMessageId: "400000000000000001"
                            lastUnreadMessageId: "400000000000000001"
                        items:
                          type: object
                          properties:
                            account_id:
                              type: string
                              example: "100000000000000001"
                            groupId:
                              type: string
                              example: "200000000000000001"
                            partnerAccountId:
                              type: string
                              example: "300000000000000001"
                            partnerUsername:
                              type: string
                              example: partner
                            flags:
                              type: integer
                              example: 0
                            unreadCount:
                              type: integer
                              example: 1
                            subscriptionTierId:
                              type: string
                              example: null
                              nullable: true
                            lastMessageId:
                              type: string
                              example: "400000000000000001"
                            lastUnreadMessageId:
                              type: string
                              example: "400000000000000001"
                      aggregationData:
                        type: object
                        properties:
                          accounts:
                            type: array
                            example:
                              - id: "300000000000000001"
                                username: partner
                                displayName: Partner
                                flags: 0
                                createdAt: 1700000000000
                                followCount: 0
                                subscriberCount: 0
                                about: About text
                                location: ""
                                following: true
                                avatar:
                                  id: "500000000000000001"
                                  type: 1
                                  mimetype: image/jpeg
                                  locations:
                                    - locationId: "1"
                                      location: https://cdn3.fansly.com/300000000000000001/500000000000000001.jpeg
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: "300000000000000001"
                                username:
                                  type: string
                                  example: partner
                                displayName:
                                  type: string
                                  example: Partner
                                flags:
                                  type: integer
                                  example: 0
                                createdAt:
                                  type: integer
                                  example: 1700000000000
                                followCount:
                                  type: integer
                                  example: 0
                                subscriberCount:
                                  type: integer
                                  example: 0
                                about:
                                  type: string
                                  example: About text
                                location:
                                  type: string
                                  example: ""
                                following:
                                  type: boolean
                                  example: true
                                avatar:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      example: "500000000000000001"
                                    type:
                                      type: integer
                                      example: 1
                                    mimetype:
                                      type: string
                                      example: image/jpeg
                                    locations:
                                      type: array
                                      example:
                                        - locationId: "1"
                                          location: https://cdn3.fansly.com/300000000000000001/500000000000000001.jpeg
                                      items:
                                        type: object
                                        properties:
                                          locationId:
                                            type: string
                                            example: "1"
                                          location:
                                            type: string
                                            example: https://cdn3.fansly.com/300000000000000001/500000000000000001.jpeg
                          groups:
                            type: array
                            example:
                              - id: "200000000000000001"
                                type: 1
                                groupFlags: 0
                                createdBy: "300000000000000001"
                                users:
                                  - groupId: "200000000000000001"
                                    userId: "300000000000000001"
                                    type: 0
                                    permissionFlags: 65535
                                  - groupId: "200000000000000001"
                                    userId: "100000000000000001"
                                    type: 0
                                    permissionFlags: 65535
                                lastMessage:
                                  id: "400000000000000001"
                                  type: 1
                                  content: Message text
                                  groupId: "200000000000000001"
                                  senderId: "300000000000000001"
                                  createdAt: 1700000000
                                  attachments: []
                                  embeds: []
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: "200000000000000001"
                                type:
                                  type: integer
                                  example: 1
                                groupFlags:
                                  type: integer
                                  example: 0
                                createdBy:
                                  type: string
                                  example: "300000000000000001"
                                users:
                                  type: array
                                  example:
                                    - groupId: "200000000000000001"
                                      userId: "300000000000000001"
                                      type: 0
                                      permissionFlags: 65535
                                    - groupId: "200000000000000001"
                                      userId: "100000000000000001"
                                      type: 0
                                      permissionFlags: 65535
                                  items:
                                    type: object
                                    properties:
                                      groupId:
                                        type: string
                                        example: "200000000000000001"
                                      userId:
                                        type: string
                                        example: "300000000000000001"
                                      type:
                                        type: integer
                                        example: 0
                                      permissionFlags:
                                        type: integer
                                        example: 65535
                                lastMessage:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      example: "400000000000000001"
                                    type:
                                      type: integer
                                      example: 1
                                    content:
                                      type: string
                                      example: Message text
                                    groupId:
                                      type: string
                                      example: "200000000000000001"
                                    senderId:
                                      type: string
                                      example: "300000000000000001"
                                    createdAt:
                                      type: integer
                                      example: 1700000000
                                    attachments:
                                      type: array
                                      example: []
                                    embeds:
                                      type: array
                                      example: []
                      hasMore:
                        type: boolean
                        example: false
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: null
                        nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055812
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Chats
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Mark All Chats as Read (/api-reference/fansly/chats/mark-all-chats-as-read)

Mark all chats as read for the Fansly Account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/{fanslyAccount}/chats/mark-all-as-read
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/chats/mark-all-as-read:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Mark All Chats as Read
      operationId: markAllChatsAsRead
      description: Mark all chats as read for the Fansly Account.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055812
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: string
                    example: null
                    nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055812
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Chats
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Show Chat (/api-reference/fansly/chats/show-chat)

Get the details of a specific chat (messaging group): members, permission flags, last message preview, and DM permissions.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/chats/{chat_id}
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/chats/{chat_id}:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The Fansly chat (group) ID.
        example: "200000000000000001"
        required: true
        schema:
          type: string
    get:
      summary: Show Chat
      operationId: showChat
      description: "Get the details of a specific chat (messaging group): members,
        permission flags, last message preview, and DM permissions."
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: "200000000000000001"
                    type: 1
                    groupFlags: 0
                    groupFlagsMetadata: ""
                    createdBy: "300000000000000001"
                    users:
                      - groupId: "200000000000000001"
                        userId: "300000000000000001"
                        type: 0
                        permissionFlags: 65535
                        dmPermissionFlags:
                          - id: "600000000000000001"
                            accountId: "300000000000000001"
                            type: 0
                            flags: 3
                            metadata: '{"1":"{\"price\":2000}"}'
                            verificationFlags: 2
                            verificationMetadata: "{}"
                      - groupId: "200000000000000001"
                        userId: "100000000000000001"
                        type: 0
                        permissionFlags: 65535
                    permissionFlags: []
                    recipients: []
                    userSettings:
                      customName: ""
                      hidden: 0
                    lastMessage:
                      id: "400000000000000001"
                      type: 1
                      dataVersion: 1
                      content: Message text
                      groupId: "200000000000000001"
                      senderId: "300000000000000001"
                      correlationId: "400000000000000099"
                      inReplyTo: null
                      inReplyToRoot: null
                      createdAt: 1700000000
                      attachments: []
                      embeds: []
                      interactions:
                        - userId: "100000000000000001"
                          readAt: 1700000000
                          deliveredAt: 1700000000
                      likes: []
                    hasDmPermissionFlags: false
                    partnerMissingDmPermissionFlagsChecked: true
                    dmPermissionFlags:
                      - id: "600000000000000001"
                        accountId: "300000000000000001"
                        type: 0
                        flags: 3
                        metadata: '{"1":"{\"price\":2000}"}'
                        verificationFlags: 2
                        verificationMetadata: "{}"
                    accountDmPermissionFlags:
                      flags: 2
                      metadata: "{}"
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055812
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: "200000000000000001"
                      type:
                        type: integer
                        example: 1
                      groupFlags:
                        type: integer
                        example: 0
                      groupFlagsMetadata:
                        type: string
                        example: ""
                      createdBy:
                        type: string
                        example: "300000000000000001"
                      users:
                        type: array
                        example:
                          - groupId: "200000000000000001"
                            userId: "300000000000000001"
                            type: 0
                            permissionFlags: 65535
                            dmPermissionFlags:
                              - id: "600000000000000001"
                                accountId: "300000000000000001"
                                type: 0
                                flags: 3
                                metadata: '{"1":"{\"price\":2000}"}'
                                verificationFlags: 2
                                verificationMetadata: "{}"
                          - groupId: "200000000000000001"
                            userId: "100000000000000001"
                            type: 0
                            permissionFlags: 65535
                        items:
                          type: object
                          properties:
                            groupId:
                              type: string
                              example: "200000000000000001"
                            userId:
                              type: string
                              example: "300000000000000001"
                            type:
                              type: integer
                              example: 0
                            permissionFlags:
                              type: integer
                              example: 65535
                            dmPermissionFlags:
                              type: array
                              example:
                                - id: "600000000000000001"
                                  accountId: "300000000000000001"
                                  type: 0
                                  flags: 3
                                  metadata: '{"1":"{\"price\":2000}"}'
                                  verificationFlags: 2
                                  verificationMetadata: "{}"
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: "600000000000000001"
                                  accountId:
                                    type: string
                                    example: "300000000000000001"
                                  type:
                                    type: integer
                                    example: 0
                                  flags:
                                    type: integer
                                    example: 3
                                  metadata:
                                    type: string
                                    example: '{"1":"{\"price\":2000}"}'
                                  verificationFlags:
                                    type: integer
                                    example: 2
                                  verificationMetadata:
                                    type: string
                                    example: "{}"
                      permissionFlags:
                        type: array
                        example: []
                      recipients:
                        type: array
                        example: []
                      userSettings:
                        type: object
                        properties:
                          customName:
                            type: string
                            example: ""
                          hidden:
                            type: integer
                            example: 0
                      lastMessage:
                        type: object
                        properties:
                          id:
                            type: string
                            example: "400000000000000001"
                          type:
                            type: integer
                            example: 1
                          dataVersion:
                            type: integer
                            example: 1
                          content:
                            type: string
                            example: Message text
                          groupId:
                            type: string
                            example: "200000000000000001"
                          senderId:
                            type: string
                            example: "300000000000000001"
                          correlationId:
                            type: string
                            example: "400000000000000099"
                          inReplyTo:
                            type: string
                            example: null
                            nullable: true
                          inReplyToRoot:
                            type: string
                            example: null
                            nullable: true
                          createdAt:
                            type: integer
                            example: 1700000000
                          attachments:
                            type: array
                            example: []
                          embeds:
                            type: array
                            example: []
                          interactions:
                            type: array
                            example:
                              - userId: "100000000000000001"
                                readAt: 1700000000
                                deliveredAt: 1700000000
                            items:
                              type: object
                              properties:
                                userId:
                                  type: string
                                  example: "100000000000000001"
                                readAt:
                                  type: integer
                                  example: 1700000000
                                deliveredAt:
                                  type: integer
                                  example: 1700000000
                          likes:
                            type: array
                            example: []
                      hasDmPermissionFlags:
                        type: boolean
                        example: false
                      partnerMissingDmPermissionFlagsChecked:
                        type: boolean
                        example: true
                      dmPermissionFlags:
                        type: array
                        example:
                          - id: "600000000000000001"
                            accountId: "300000000000000001"
                            type: 0
                            flags: 3
                            metadata: '{"1":"{\"price\":2000}"}'
                            verificationFlags: 2
                            verificationMetadata: "{}"
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: "600000000000000001"
                            accountId:
                              type: string
                              example: "300000000000000001"
                            type:
                              type: integer
                              example: 0
                            flags:
                              type: integer
                              example: 3
                            metadata:
                              type: string
                              example: '{"1":"{\"price\":2000}"}'
                            verificationFlags:
                              type: integer
                              example: 2
                            verificationMetadata:
                              type: string
                              example: "{}"
                      accountDmPermissionFlags:
                        type: object
                        properties:
                          flags:
                            type: integer
                            example: 2
                          metadata:
                            type: string
                            example: "{}"
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055812
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Chats
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Start Typing Indicator (/api-reference/fansly/chats/start-typing-indicator)

Calling this endpoint will show the target fan a "Model is typing..." note in the chat for \~3 seconds. If you want to continue showing the indicator, call this endpoint multiple times. Free - no credits charged.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/{fanslyAccount}/chats/{chat_id}/typing
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/chats/{chat_id}/typing:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The Fansly chat (group) ID.
        example: "200000000000000001"
        required: true
        schema:
          type: string
    post:
      summary: Start Typing Indicator
      operationId: startTypingIndicator
      description: Calling this endpoint will show the target fan a "Model is
        typing..." note in the chat for ~3 seconds. If you want to continue
        showing the indicator, call this endpoint multiple times. Free - no
        credits charged.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055812
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: string
                    example: null
                    nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055812
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Chats
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Earnings Stats (/api-reference/fansly/earnings/get-earnings-stats)

Get earnings aggregated by transaction type over a date range.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/earnings/stats
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/earnings/stats:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Earnings Stats
      operationId: getEarningsStats
      description: Get earnings aggregated by transaction type over a date range.
      parameters:
        - in: query
          name: before
          description: End of the date range (ISO 8601). Defaults to now.
          example: 2026-06-03T23:59:59Z
          required: false
          schema:
            type: string
            description: End of the date range (ISO 8601). Defaults to now.
            example: 2026-06-03T23:59:59Z
        - in: query
          name: after
          description: Start of the date range (ISO 8601). Defaults to 30 days ago.
          example: 2026-05-03T00:00:00Z
          required: false
          schema:
            type: string
            description: Start of the date range (ISO 8601). Defaults to 30 days ago.
            example: 2026-05-03T00:00:00Z
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - type: 2116
                      totalGross: 5000
                      totalNet: 4000
                      accountId: "800000000000000001"
                      timestamp: 1780358400000
                    - type: 15001
                      totalGross: 10000
                      totalNet: 8000
                      accountId: "800000000000000001"
                      timestamp: 1780444800000
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055765
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: array
                    example:
                      - type: 2116
                        totalGross: 5000
                        totalNet: 4000
                        accountId: "800000000000000001"
                        timestamp: 1780358400000
                      - type: 15001
                        totalGross: 10000
                        totalNet: 8000
                        accountId: "800000000000000001"
                        timestamp: 1780444800000
                    items:
                      type: object
                      properties:
                        type:
                          type: integer
                          example: 2116
                        totalGross:
                          type: integer
                          example: 5000
                        totalNet:
                          type: integer
                          example: 4000
                        accountId:
                          type: string
                          example: "800000000000000001"
                        timestamp:
                          type: integer
                          example: 1780358400000
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055765
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Earnings
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Pending Earnings (/api-reference/fansly/earnings/get-pending-earnings)

Get the current pending balance. Funds are pending for 7 days from the day they are received and unlock on a rolling basis.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/earnings/pending
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/earnings/pending:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Pending Earnings
      operationId: getPendingEarnings
      description: Get the current pending balance. Funds are pending for 7 days from
        the day they are received and unlock on a rolling basis.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    pendingBalance: 4416784
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055770
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      pendingBalance:
                        type: integer
                        example: 4416784
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055770
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Earnings
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Monthly Earnings (/api-reference/fansly/earnings/list-monthly-earnings)

Get monthly earnings ("Statements" in the Fansly Creator Dashboard). The first entry is a rolling 30-day summary, followed by per-calendar-month totals with gross/net revenue and top-performer percentile.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/earnings/monthly
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/earnings/monthly:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Monthly Earnings
      operationId: listMonthlyEarnings
      description: Get monthly earnings ("Statements" in the Fansly Creator
        Dashboard). The first entry is a rolling 30-day summary, followed by
        per-calendar-month totals with gross/net revenue and top-performer
        percentile.
      parameters:
        - in: query
          name: before
          description: End of the range (ISO 8601). Defaults to now.
          example: 2026-06-03T23:59:59Z
          required: false
          schema:
            type: string
            description: End of the range (ISO 8601). Defaults to now.
            example: 2026-06-03T23:59:59Z
        - in: query
          name: after
          description: Start of the range (ISO 8601). Defaults to the start of the current
            year.
          example: 2026-01-01T00:00:00Z
          required: false
          schema:
            type: string
            description: Start of the range (ISO 8601). Defaults to the start of the current
              year.
            example: 2026-01-01T00:00:00Z
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - year: 0
                      month: 0
                      totalGross: 200000
                      totalNet: 160000
                      before: 1780358400000
                      after: 1777766400000
                      topPercent: 5
                      maxTopPercent: 100
                      brackets: []
                    - year: 2026
                      month: 5
                      totalGross: 180000
                      totalNet: 144000
                      before: 1780358400000
                      after: 1777766400000
                      topPercent: 6
                      maxTopPercent: 100
                      brackets: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055766
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: array
                    example:
                      - year: 0
                        month: 0
                        totalGross: 200000
                        totalNet: 160000
                        before: 1780358400000
                        after: 1777766400000
                        topPercent: 5
                        maxTopPercent: 100
                        brackets: []
                      - year: 2026
                        month: 5
                        totalGross: 180000
                        totalNet: 144000
                        before: 1780358400000
                        after: 1777766400000
                        topPercent: 6
                        maxTopPercent: 100
                        brackets: []
                    items:
                      type: object
                      properties:
                        year:
                          type: integer
                          example: 0
                        month:
                          type: integer
                          example: 0
                        totalGross:
                          type: integer
                          example: 200000
                        totalNet:
                          type: integer
                          example: 160000
                        before:
                          type: integer
                          example: 1780358400000
                        after:
                          type: integer
                          example: 1777766400000
                        topPercent:
                          type: integer
                          example: 5
                        maxTopPercent:
                          type: integer
                          example: 100
                        brackets:
                          type: array
                          example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055766
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Earnings
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Payout Requests (/api-reference/fansly/earnings/list-payout-requests)

Get the list of submitted payout requests with amount, status, and timestamps.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/earnings/payouts
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/earnings/payouts:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Payout Requests
      operationId: listPayoutRequests
      description: Get the list of submitted payout requests with amount, status, and
        timestamps.
      parameters:
        - in: query
          name: limit
          description: Number of payout requests to return (1 - 100). Default = 10
          example: 10
          required: false
          schema:
            type: string
            description: Number of payout requests to return (1 - 100). Default = 10
            example: 10
        - in: query
          name: offset
          description: Pagination offset. Default = 0
          example: 0
          required: false
          schema:
            type: string
            description: Pagination offset. Default = 0
            example: 0
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    total: 2
                    data:
                      - id: "300000000000000001"
                        accountId: "800000000000000001"
                        amount: 50000
                        payoutMethodId: "400000000000000001"
                        status: 1
                        version: 1
                        createdAt: 1780358400000
                        updatedAt: 1780358400000
                      - id: "300000000000000002"
                        accountId: "800000000000000001"
                        amount: 75000
                        payoutMethodId: "400000000000000001"
                        status: 2
                        version: 2
                        createdAt: 1779753600000
                        updatedAt: 1779840000000
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055769
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      total:
                        type: integer
                        example: 2
                      data:
                        type: array
                        example:
                          - id: "300000000000000001"
                            accountId: "800000000000000001"
                            amount: 50000
                            payoutMethodId: "400000000000000001"
                            status: 1
                            version: 1
                            createdAt: 1780358400000
                            updatedAt: 1780358400000
                          - id: "300000000000000002"
                            accountId: "800000000000000001"
                            amount: 75000
                            payoutMethodId: "400000000000000001"
                            status: 2
                            version: 2
                            createdAt: 1779753600000
                            updatedAt: 1779840000000
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: "300000000000000001"
                            accountId:
                              type: string
                              example: "800000000000000001"
                            amount:
                              type: integer
                              example: 50000
                            payoutMethodId:
                              type: string
                              example: "400000000000000001"
                            status:
                              type: integer
                              example: 1
                            version:
                              type: integer
                              example: 1
                            createdAt:
                              type: integer
                              example: 1780358400000
                            updatedAt:
                              type: integer
                              example: 1780358400000
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055769
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Earnings
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Wallet Transactions (/api-reference/fansly/earnings/list-wallet-transactions)

Get the transaction ledger ("Wallet History" in the Fansly Creator Dashboard) — every earnings event with running balance and timestamps.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/earnings/transactions
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/earnings/transactions:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Wallet Transactions
      operationId: listWalletTransactions
      description: Get the transaction ledger ("Wallet History" in the Fansly Creator
        Dashboard) — every earnings event with running balance and timestamps.
      parameters:
        - in: query
          name: limit
          description: Number of transactions to return (1 - 100). Default = 10
          example: 10
          required: false
          schema:
            type: string
            description: Number of transactions to return (1 - 100). Default = 10
            example: 10
        - in: query
          name: offset
          description: Pagination offset. Default = 0
          example: 0
          required: false
          schema:
            type: string
            description: Pagination offset. Default = 0
            example: 0
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    total: 3
                    data:
                      - transactionId: "500000000000000001"
                        type: 2116
                        destination: wallet
                        amount: 5000
                        destinationTax: 1000
                        newBalance: 105000
                        createdAt: 1780444800000
                        status: 1
                      - transactionId: "500000000000000002"
                        type: 2116
                        destination: wallet
                        amount: 10000
                        destinationTax: 2000
                        newBalance: 100000
                        createdAt: 1780358400000
                        status: 1
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055768
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      total:
                        type: integer
                        example: 3
                      data:
                        type: array
                        example:
                          - transactionId: "500000000000000001"
                            type: 2116
                            destination: wallet
                            amount: 5000
                            destinationTax: 1000
                            newBalance: 105000
                            createdAt: 1780444800000
                            status: 1
                          - transactionId: "500000000000000002"
                            type: 2116
                            destination: wallet
                            amount: 10000
                            destinationTax: 2000
                            newBalance: 100000
                            createdAt: 1780358400000
                            status: 1
                        items:
                          type: object
                          properties:
                            transactionId:
                              type: string
                              example: "500000000000000001"
                            type:
                              type: integer
                              example: 2116
                            destination:
                              type: string
                              example: wallet
                            amount:
                              type: integer
                              example: 5000
                            destinationTax:
                              type: integer
                              example: 1000
                            newBalance:
                              type: integer
                              example: 105000
                            createdAt:
                              type: integer
                              example: 1780444800000
                            status:
                              type: integer
                              example: 1
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055768
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Earnings
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Wallets (/api-reference/fansly/earnings/list-wallets)

Get all wallets for the Fansly Account. Type 1 is the standard wallet; type 2 is "Available for Payout" (always present for creators).

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/earnings/wallets
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/earnings/wallets:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Wallets
      operationId: listWallets
      description: Get all wallets for the Fansly Account. Type 1 is the standard
        wallet; type 2 is "Available for Payout" (always present for creators).
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - id: "600000000000000001"
                      balance: 105000
                      balance64: "105000"
                      accountId: "800000000000000001"
                      type: 1
                      flags: 0
                      walletVersion: 1
                    - id: "600000000000000002"
                      balance: 50000
                      balance64: "50000"
                      accountId: "800000000000000001"
                      type: 2
                      flags: 0
                      walletVersion: 1
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055767
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: array
                    example:
                      - id: "600000000000000001"
                        balance: 105000
                        balance64: "105000"
                        accountId: "800000000000000001"
                        type: 1
                        flags: 0
                        walletVersion: 1
                      - id: "600000000000000002"
                        balance: 50000
                        balance64: "50000"
                        accountId: "800000000000000001"
                        type: 2
                        flags: 0
                        walletVersion: 1
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: "600000000000000001"
                        balance:
                          type: integer
                          example: 105000
                        balance64:
                          type: string
                          example: "105000"
                        accountId:
                          type: string
                          example: "800000000000000001"
                        type:
                          type: integer
                          example: 1
                        flags:
                          type: integer
                          example: 0
                        walletVersion:
                          type: integer
                          example: 1
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055767
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Earnings
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Poll Authentication Status (/api-reference/fansly/connect-fansly-account/poll-authentication-status)

Poll the status of a Fansly authentication process. When verification is required, `needs_code` is `true` and `twofa_type` indicates whether the code comes from the creator's email (`2`) or authenticator app (`0`). Submit the code via the Submit 2FA endpoint.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/authenticate/{fanslyAccount}
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/authenticate/{fanslyAccount}:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly account ID returned by Start Authentication
        example: fansly_acct_XXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Poll Authentication Status
      operationId: pollAuthenticationStatus
      description: Poll the status of a Fansly authentication process. When
        verification is required, `needs_code` is `true` and `twofa_type`
        indicates whether the code comes from the creator's email (`2`) or
        authenticator app (`0`). Submit the code via the Submit 2FA endpoint.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  account_id: fansly_acct_123
                  display_name: My Fansly
                  status: challenge-email
                  is_authenticated: false
                  needs_code: true
                  twofa_type: 2
                  masked_email: t**@e*****.com
                  last_error: null
                  fansly_user_data: null
                properties:
                  account_id:
                    type: string
                    example: fansly_acct_123
                  display_name:
                    type: string
                    example: My Fansly
                  status:
                    type: string
                    example: challenge-email
                  is_authenticated:
                    type: boolean
                    example: false
                  needs_code:
                    type: boolean
                    example: true
                  twofa_type:
                    type: integer
                    example: 2
                  masked_email:
                    type: string
                    example: t**@e*****.com
                  last_error:
                    type: string
                    example: null
                    nullable: true
                  fansly_user_data:
                    type: string
                    example: null
                    nullable: true
      tags:
        - Connect Fansly Account
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Re-authenticate Account (/api-reference/fansly/connect-fansly-account/re-authenticate-account)

Trigger re-authentication for an existing Fansly account without re-submitting the username & password. Uses the credentials stored when the account was first connected.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/authenticate/{fanslyAccount}/reauthenticate
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/authenticate/{fanslyAccount}/reauthenticate:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly account ID
        example: fansly_acct_XXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Re-authenticate Account
      operationId: reAuthenticateAccount
      description: Trigger re-authentication for an existing Fansly account without
        re-submitting the username & password. Uses the credentials stored when
        the account was first connected.
      parameters: []
      responses:
        "200":
          description: Re-authentication started
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  message: Re-authentication started.
                  polling_url: https://api.example.com/api/fansly/authenticate/fansly_acct_123
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Re-authentication started.
                  polling_url:
                    type: string
                    example: https://api.example.com/api/fansly/authenticate/fansly_acct_123
        "400":
          description: When re-authentication is not possible
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Can't re-authenticate account at this time.
                  reason: Account is already successfully authenticated
                properties:
                  message:
                    type: string
                    example: Can't re-authenticate account at this time.
                  reason:
                    type: string
                    example: Account is already successfully authenticated
      tags:
        - Connect Fansly Account
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Start Authentication (/api-reference/fansly/connect-fansly-account/start-authentication)

Start the authentication process for a new Fansly account using the account's username (or email) and password. If Fansly requires verification, the response status will indicate a pending challenge — either an emailed code (new IP) or an authenticator-app code — which you submit via the Submit 2FA endpoint. Credentials are stored securely and encrypted at rest.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/authenticate
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/authenticate:
    post:
      summary: Start Authentication
      operationId: startAuthentication
      description: Start the authentication process for a new Fansly account using the
        account's username (or email) and password. If Fansly requires
        verification, the response status will indicate a pending challenge —
        either an emailed code (new IP) or an authenticator-app code — which you
        submit via the Submit 2FA endpoint. Credentials are stored securely and
        encrypted at rest.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  account_id: fansly_acct_123
                  message: Authentication process started. Query the polling_url to check the
                    progress.
                  polling_url: https://api.example.com/api/fansly/authenticate/fansly_acct_123
                properties:
                  account_id:
                    type: string
                    example: fansly_acct_123
                  message:
                    type: string
                    example: Authentication process started. Query the polling_url to check the
                      progress.
                  polling_url:
                    type: string
                    example: https://api.example.com/api/fansly/authenticate/fansly_acct_123
      tags:
        - Connect Fansly Account
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: A display name for the account. If omitted, defaults to the
                    username.
                  example: veniam
                username:
                  type: string
                  description: The Fansly username or email used to sign in.
                  example: consequuntur
                password:
                  type: string
                  description: The Fansly account password.
                  example: "%iQ]Qd"
                proxyCountry:
                  type: string
                  description: The country of the managed proxy server you want to use. Eg. "us"
                    for United States. Cannot be used together with customProxy.
                  example: uk
                  enum:
                    - us
                    - uk
                    - gb
                customProxy:
                  type: object
                  description: Custom proxy configuration. Cannot be used together with
                    proxyCountry.
                  example: []
                  properties:
                    host:
                      type: string
                      description: The hostname or IP address of your custom proxy server
                      example: proxy.example.com
                    port:
                      type: integer
                      description: The port number of your custom proxy server (1-65535)
                      example: 8080
                    username:
                      type: string
                      description: The username for proxy authentication (optional)
                      example: sit
                    password:
                      type: string
                      description: The password for proxy authentication (optional)
                      example: e/]"xh}wm=d@P
                force_connect:
                  type: boolean
                  description: Set to true to connect the account even if it already exists
                  example: false
              required:
                - username
                - password
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Submit 2FA (/api-reference/fansly/connect-fansly-account/submit2fa)

Submit the verification code for a pending Fansly challenge (emailed new-IP code or authenticator-app code). If the code is invalid the challenge remains in place so you can retry.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml put /api/fansly/authenticate/{fanslyAccount}
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/authenticate/{fanslyAccount}:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly account ID returned by Start Authentication
        example: fansly_acct_XXXXXXX
        required: true
        schema:
          type: string
    put:
      summary: Submit 2FA
      operationId: submit2FA
      description: Submit the verification code for a pending Fansly challenge
        (emailed new-IP code or authenticator-app code). If the code is invalid
        the challenge remains in place so you can retry.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  account_id: fansly_acct_123
                  display_name: My Fansly
                  status: verifying
                  is_authenticated: false
                  needs_code: true
                  twofa_type: 2
                  masked_email: t**@e*****.com
                  last_error: null
                  fansly_user_data: null
                properties:
                  account_id:
                    type: string
                    example: fansly_acct_123
                  display_name:
                    type: string
                    example: My Fansly
                  status:
                    type: string
                    example: verifying
                  is_authenticated:
                    type: boolean
                    example: false
                  needs_code:
                    type: boolean
                    example: true
                  twofa_type:
                    type: integer
                    example: 2
                  masked_email:
                    type: string
                    example: t**@e*****.com
                  last_error:
                    type: string
                    example: null
                    nullable: true
                  fansly_user_data:
                    type: string
                    example: null
                    nullable: true
      tags:
        - Connect Fansly Account
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                code:
                  type: string
                  description: The verification code from the creator's email or authenticator
                    app.
                  example: "123456"
              required:
                - code
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Following (/api-reference/fansly/following/list-following)

Get the list of accounts the authenticated Fansly Account is following. Fansly only returns the account IDs here — use the **Get User Details** endpoint with the `ids` query parameter to hydrate them into full profiles.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/following
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/following:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Following
      operationId: listFollowing
      description: Get the list of accounts the authenticated Fansly Account is
        following. Fansly only returns the account IDs here — use the **Get User
        Details** endpoint with the `ids` query parameter to hydrate them into
        full profiles.
      parameters:
        - in: query
          name: limit
          description: Number of accounts to return (1 - 100). Default = 20
          example: 20
          required: false
          schema:
            type: string
            description: Number of accounts to return (1 - 100). Default = 20
            example: 20
        - in: query
          name: offset
          description: Number of accounts to skip for pagination. Default = 0
          example: 0
          required: false
          schema:
            type: string
            description: Number of accounts to skip for pagination. Default = 0
            example: 0
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    following:
                      - accountId: "800000000000000010"
                      - accountId: "800000000000000011"
                      - accountId: "800000000000000012"
                    hasMore: false
                  _pagination:
                    next_page: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055809
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      following:
                        type: array
                        example:
                          - accountId: "800000000000000010"
                          - accountId: "800000000000000011"
                          - accountId: "800000000000000012"
                        items:
                          type: object
                          properties:
                            accountId:
                              type: string
                              example: "800000000000000010"
                      hasMore:
                        type: boolean
                        example: false
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: null
                        nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055809
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Following
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Followers (/api-reference/fansly/followers/list-followers)

Get the list of followers for a Fansly Account. Followers are accounts that have followed (but not necessarily subscribed to) the creator.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/followers
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/followers:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Followers
      operationId: listFollowers
      description: Get the list of followers for a Fansly Account. Followers are
        accounts that have followed (but not necessarily subscribed to) the
        creator.
      parameters:
        - in: query
          name: limit
          description: Number of followers to return (1 - 100). Default = 20
          example: 20
          required: false
          schema:
            type: string
            description: Number of followers to return (1 - 100). Default = 20
            example: 20
        - in: query
          name: before
          description: "Pagination cursor: the `id` of the last entry in the previous
            page's `followers` list. Omit for the first page. The
            `_pagination.next_page` URL in the response has this set for you."
          example: "923039675050909696"
          required: false
          schema:
            type: string
            description: "Pagination cursor: the `id` of the last entry in the previous
              page's `followers` list. Omit for the first page. The
              `_pagination.next_page` URL in the response has this set for you."
            example: "923039675050909696"
        - in: query
          name: offset
          description: Deprecated — Fansly no longer honors offset pagination on this
            endpoint; use the `before` cursor instead. Still accepted (and
            forwarded) so existing integrations don't break.
          example: 0
          required: false
          schema:
            type: string
            description: Deprecated — Fansly no longer honors offset pagination on this
              endpoint; use the `before` cursor instead. Still accepted (and
              forwarded) so existing integrations don't break.
            example: 0
        - in: query
          name: search
          description: Search followers by username/display name
          example: ""
          required: false
          schema:
            type: string
            description: Search followers by username/display name
            example: ""
        - in: query
          name: last_seen_after
          description: Filter to followers last seen after this timestamp (ISO 8601). The
            Fansly Creator Dashboard "Online" filter passes the moment 15
            minutes ago.
          example: 2026-06-03T18:28:09Z
          required: false
          schema:
            type: string
            description: Filter to followers last seen after this timestamp (ISO 8601). The
              Fansly Creator Dashboard "Online" filter passes the moment 15
              minutes ago.
            example: 2026-06-03T18:28:09Z
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    followers:
                      - id: "500000000000000001"
                        followerId: "600000000000000001"
                      - id: "500000000000000002"
                        followerId: "600000000000000002"
                    aggregationData:
                      accounts:
                        - id: "600000000000000001"
                          username: fanfollower1
                          displayName: null
                          flags: 16
                          version: 1
                          createdAt: 1780400012000
                          followCount: 1
                          subscriberCount: 0
                          statusId: 1
                          lastSeenAt: 1780472357000
                          followsYou: true
                          profileAccess: true
                          userFlags: 2
                        - id: "600000000000000002"
                          username: fanfollower2
                          displayName: Jamie
                          flags: 0
                          version: 3
                          createdAt: 1780290012000
                          followCount: 14
                          subscriberCount: 0
                          statusId: 1
                          lastSeenAt: 1780472357000
                          followsYou: true
                          profileAccess: true
                          userFlags: 2
                    hasMore: false
                  _pagination:
                    next_page: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055809
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      followers:
                        type: array
                        example:
                          - id: "500000000000000001"
                            followerId: "600000000000000001"
                          - id: "500000000000000002"
                            followerId: "600000000000000002"
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: "500000000000000001"
                            followerId:
                              type: string
                              example: "600000000000000001"
                      aggregationData:
                        type: object
                        properties:
                          accounts:
                            type: array
                            example:
                              - id: "600000000000000001"
                                username: fanfollower1
                                displayName: null
                                flags: 16
                                version: 1
                                createdAt: 1780400012000
                                followCount: 1
                                subscriberCount: 0
                                statusId: 1
                                lastSeenAt: 1780472357000
                                followsYou: true
                                profileAccess: true
                                userFlags: 2
                              - id: "600000000000000002"
                                username: fanfollower2
                                displayName: Jamie
                                flags: 0
                                version: 3
                                createdAt: 1780290012000
                                followCount: 14
                                subscriberCount: 0
                                statusId: 1
                                lastSeenAt: 1780472357000
                                followsYou: true
                                profileAccess: true
                                userFlags: 2
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: "600000000000000001"
                                username:
                                  type: string
                                  example: fanfollower1
                                displayName:
                                  type: string
                                  example: null
                                  nullable: true
                                flags:
                                  type: integer
                                  example: 16
                                version:
                                  type: integer
                                  example: 1
                                createdAt:
                                  type: integer
                                  example: 1780400012000
                                followCount:
                                  type: integer
                                  example: 1
                                subscriberCount:
                                  type: integer
                                  example: 0
                                statusId:
                                  type: integer
                                  example: 1
                                lastSeenAt:
                                  type: integer
                                  example: 1780472357000
                                followsYou:
                                  type: boolean
                                  example: true
                                profileAccess:
                                  type: boolean
                                  example: true
                                userFlags:
                                  type: integer
                                  example: 2
                      hasMore:
                        type: boolean
                        example: false
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: null
                        nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055809
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Followers
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Cancel Scheduled Mass Message (/api-reference/fansly/mass-messaging/cancel-scheduled-mass-message)

Cancel a pending scheduled broadcast so it will not be sent.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml delete /api/fansly/{fanslyAccount}/mass-messaging/{broadcast_id}
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/mass-messaging/{broadcast_id}:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: broadcast_id
        description: The scheduled broadcast ID (from the List Scheduled Mass Messages
          endpoint).
        example: "300000000000000020"
        required: true
        schema:
          type: string
    delete:
      summary: Cancel Scheduled Mass Message
      operationId: cancelScheduledMassMessage
      description: Cancel a pending scheduled broadcast so it will not be sent.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: "300000000000000020"
                    accountId: "800000000000000001"
                    status: 3
                    messageTemplate: '{"type":1,"attachments":[],"content":"Hey everyone, new
                      content is
                      live!","groupId":"200000000000000020","senderId":"800000000000000001","scheduledFor":1785110912000,"clientCreatedAt":1784502540759,"gatewayMetadata":{"createdAt":1784502540831,"correlationId":"300000000000000021"}}'
                    version: 0
                    scheduledFor: 1785110912000
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055789
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: "300000000000000020"
                      accountId:
                        type: string
                        example: "800000000000000001"
                      status:
                        type: integer
                        example: 3
                      messageTemplate:
                        type: string
                        example: '{"type":1,"attachments":[],"content":"Hey everyone, new content is
                          live!","groupId":"200000000000000020","senderId":"800000000000000001","scheduledFor":1785110912000,"clientCreatedAt":1784502540759,"gatewayMetadata":{"createdAt":1784502540831,"correlationId":"300000000000000021"}}'
                      version:
                        type: integer
                        example: 0
                      scheduledFor:
                        type: integer
                        example: 1785110912000
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055789
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Mass Messaging
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Scheduled Mass Messages (/api-reference/fansly/mass-messaging/list-scheduled-mass-messages)

List the account's pending scheduled broadcasts. The response also includes the `groups` referenced by the scheduled messages — each `groupId` is a broadcast group that defines the recipient set (subscribers, lists, excluded users).

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/mass-messaging
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/mass-messaging:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Scheduled Mass Messages
      operationId: listScheduledMassMessages
      description: List the account's pending scheduled broadcasts. The response also
        includes the `groups` referenced by the scheduled messages — each
        `groupId` is a broadcast group that defines the recipient set
        (subscribers, lists, excluded users).
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    scheduledBroadcastMessages:
                      - id: "300000000000000020"
                        groupId: "200000000000000020"
                        accountId: "800000000000000001"
                        status: 1
                        messageTemplate: '{"type":1,"attachments":[],"content":"Hey everyone, new
                          content is
                          live!","groupId":"200000000000000020","senderId":"800000000000000001","scheduledFor":1785110911809,"clientCreatedAt":1784502540759,"gatewayMetadata":{"createdAt":1784502540831,"correlationId":"300000000000000021"}}'
                        version: 0
                        scheduledFor: 1785110912000
                    groups:
                      - id: "200000000000000020"
                        type: 3
                        groupFlags: 126
                        groupFlagsMetadata: ""
                        createdBy: "800000000000000001"
                        users:
                          - groupId: "200000000000000020"
                            userId: "900000000000000001"
                            type: 0
                            permissionFlags: 0
                            userSettings:
                              customName: ""
                              hidden: 1
                          - groupId: "200000000000000020"
                            userId: "800000000000000001"
                            type: 0
                            permissionFlags: 65535
                            userSettings:
                              customName: ""
                              hidden: 0
                        permissionFlags: []
                        recipients:
                          - groupId: "200000000000000020"
                            recipientId: "900000000000000002"
                            type: 30000
                            permissionFlags: null
                          - groupId: "200000000000000020"
                            recipientId: "900000000000000003"
                            type: 30001
                            permissionFlags: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055789
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      scheduledBroadcastMessages:
                        type: array
                        example:
                          - id: "300000000000000020"
                            groupId: "200000000000000020"
                            accountId: "800000000000000001"
                            status: 1
                            messageTemplate: '{"type":1,"attachments":[],"content":"Hey everyone, new
                              content is
                              live!","groupId":"200000000000000020","senderId":"800000000000000001","scheduledFor":1785110911809,"clientCreatedAt":1784502540759,"gatewayMetadata":{"createdAt":1784502540831,"correlationId":"300000000000000021"}}'
                            version: 0
                            scheduledFor: 1785110912000
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: "300000000000000020"
                            groupId:
                              type: string
                              example: "200000000000000020"
                            accountId:
                              type: string
                              example: "800000000000000001"
                            status:
                              type: integer
                              example: 1
                            messageTemplate:
                              type: string
                              example: '{"type":1,"attachments":[],"content":"Hey everyone, new content is
                                live!","groupId":"200000000000000020","senderId":"800000000000000001","scheduledFor":1785110911809,"clientCreatedAt":1784502540759,"gatewayMetadata":{"createdAt":1784502540831,"correlationId":"300000000000000021"}}'
                            version:
                              type: integer
                              example: 0
                            scheduledFor:
                              type: integer
                              example: 1785110912000
                      groups:
                        type: array
                        example:
                          - id: "200000000000000020"
                            type: 3
                            groupFlags: 126
                            groupFlagsMetadata: ""
                            createdBy: "800000000000000001"
                            users:
                              - groupId: "200000000000000020"
                                userId: "900000000000000001"
                                type: 0
                                permissionFlags: 0
                                userSettings:
                                  customName: ""
                                  hidden: 1
                              - groupId: "200000000000000020"
                                userId: "800000000000000001"
                                type: 0
                                permissionFlags: 65535
                                userSettings:
                                  customName: ""
                                  hidden: 0
                            permissionFlags: []
                            recipients:
                              - groupId: "200000000000000020"
                                recipientId: "900000000000000002"
                                type: 30000
                                permissionFlags: null
                              - groupId: "200000000000000020"
                                recipientId: "900000000000000003"
                                type: 30001
                                permissionFlags: null
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: "200000000000000020"
                            type:
                              type: integer
                              example: 3
                            groupFlags:
                              type: integer
                              example: 126
                            groupFlagsMetadata:
                              type: string
                              example: ""
                            createdBy:
                              type: string
                              example: "800000000000000001"
                            users:
                              type: array
                              example:
                                - groupId: "200000000000000020"
                                  userId: "900000000000000001"
                                  type: 0
                                  permissionFlags: 0
                                  userSettings:
                                    customName: ""
                                    hidden: 1
                                - groupId: "200000000000000020"
                                  userId: "800000000000000001"
                                  type: 0
                                  permissionFlags: 65535
                                  userSettings:
                                    customName: ""
                                    hidden: 0
                              items:
                                type: object
                                properties:
                                  groupId:
                                    type: string
                                    example: "200000000000000020"
                                  userId:
                                    type: string
                                    example: "900000000000000001"
                                  type:
                                    type: integer
                                    example: 0
                                  permissionFlags:
                                    type: integer
                                    example: 0
                                  userSettings:
                                    type: object
                                    properties:
                                      customName:
                                        type: string
                                        example: ""
                                      hidden:
                                        type: integer
                                        example: 1
                            permissionFlags:
                              type: array
                              example: []
                            recipients:
                              type: array
                              example:
                                - groupId: "200000000000000020"
                                  recipientId: "900000000000000002"
                                  type: 30000
                                  permissionFlags: null
                                - groupId: "200000000000000020"
                                  recipientId: "900000000000000003"
                                  type: 30001
                                  permissionFlags: null
                              items:
                                type: object
                                properties:
                                  groupId:
                                    type: string
                                    example: "200000000000000020"
                                  recipientId:
                                    type: string
                                    example: "900000000000000002"
                                  type:
                                    type: integer
                                    example: 30000
                                  permissionFlags:
                                    type: string
                                    example: null
                                    nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055789
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Mass Messaging
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Send Mass Message (/api-reference/fansly/mass-messaging/send-mass-message)

Send a broadcast to the recipients defined by a broadcast `groupId`. Provide `text`, one or more media IDs in `mediaFiles`, or both. Pass a future `scheduledFor` (Unix timestamp in milliseconds) to schedule it instead of sending immediately — scheduled broadcasts can later be edited or cancelled. The `groupId` (which encodes the recipient filters) is configured on the Fansly dashboard; you can reuse a `groupId` returned by the List Scheduled Mass Messages endpoint.

Attached media can be gated with any combination of the `requirePurchase`, `requireSubscription`, and `requireFollow` options (they stack — e.g. a media can require both a subscription and a purchase). The gating applies to all attached media: a single file, or the whole bundle when several are attached. When none of the gating options are sent, media keeps the default (subscription-gated) visibility.

Any attached media can be given a free preview — a separate media shown unlocked while the paid media is locked — via `previews`, a map of `mediaFiles` handle to preview handle.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/{fanslyAccount}/mass-messaging
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/mass-messaging:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Send Mass Message
      operationId: sendMassMessage
      description: >-
        Send a broadcast to the recipients defined by a broadcast `groupId`.
        Provide `text`, one or more media IDs in `mediaFiles`, or both. Pass a
        future `scheduledFor` (Unix timestamp in milliseconds) to schedule it
        instead of sending immediately — scheduled broadcasts can later be
        edited or cancelled. The `groupId` (which encodes the recipient filters)
        is configured on the Fansly dashboard; you can reuse a `groupId`
        returned by the List Scheduled Mass Messages endpoint.


        Attached media can be gated with any combination of the
        `requirePurchase`, `requireSubscription`, and `requireFollow` options
        (they stack — e.g. a media can require both a subscription and a
        purchase). The gating applies to all attached media: a single file, or
        the whole bundle when several are attached. When none of the gating
        options are sent, media keeps the default (subscription-gated)
        visibility.


        Any attached media can be given a free preview — a separate media shown
        unlocked while the paid media is locked — via `previews`, a map of
        `mediaFiles` handle to preview handle.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data: broadcast sent
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055789
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: string
                    example: broadcast sent
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055789
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Mass Messaging
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                groupId:
                  type: string
                  description: The broadcast group ID defining the recipients. Reuse a `groupId`
                    from the List Scheduled Mass Messages endpoint.
                  example: "200000000000000020"
                text:
                  type: string
                  description: The message text content. Required unless `mediaFiles` is provided.
                  example: Hey everyone, new content is live!
                mediaFiles:
                  type: array
                  description: Media to attach, as `fansly_media_` upload IDs returned by the
                    Upload Media endpoint. A single item is sent as one
                    attachment; multiple are grouped into a bundle.
                  example:
                    - fansly_media_01JR1234
                  items:
                    type: string
                requirePurchase:
                  type: boolean
                  description: Require the fan to purchase (unlock) the attached media. Requires
                    `price`. Combinable with `requireSubscription` /
                    `requireFollow`.
                  example: false
                price:
                  type: integer
                  description: Unlock price for `requirePurchase`, in Fansly's smallest unit —
                    1000 = $1.00 (e.g. 10000 = $10.00). Required when
                    `requirePurchase` is true.
                  example: 10000
                requireSubscription:
                  type: boolean
                  description: Require the fan to be subscribed to view the attached media.
                    Combinable with `requirePurchase` / `requireFollow`.
                  example: false
                subscriptionTierId:
                  type: string
                  description: Restrict `requireSubscription` to a single subscription tier. Tier
                    IDs come from the List Subscription Tiers endpoint. Omit for
                    any tier.
                  example: "843584256474116096"
                requireFollow:
                  type: boolean
                  description: Require the fan to follow the account to view the attached media.
                    Combinable with `requirePurchase` / `requireSubscription`.
                  example: false
                previews:
                  type: object
                  description: Free previews for attached media, as a map of a `mediaFiles` handle
                    to a `fansly_media_` preview upload. Each preview is shown
                    unlocked while its (gated) media is locked. Only include
                    media that should have a preview.
                  example:
                    fansly_media_01JR1234: fansly_media_01JR5678
                  properties: {}
                scheduledFor:
                  type: integer
                  description: Unix timestamp in milliseconds to schedule the broadcast for the
                    future. Keep empty (or 0) to send immediately.
                  example: 1785110911809
              required:
                - groupId
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Update Scheduled Mass Message (/api-reference/fansly/mass-messaging/update-scheduled-mass-message)

Edit a pending scheduled broadcast. Fansly replaces the message on edit, so send the complete desired state — `text` and `scheduledFor`. Pass the existing `scheduledFor` (from the List Scheduled Mass Messages endpoint) to keep the schedule time unchanged.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml put /api/fansly/{fanslyAccount}/mass-messaging/{broadcast_id}
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/mass-messaging/{broadcast_id}:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: broadcast_id
        description: The scheduled broadcast ID (from the List Scheduled Mass Messages
          endpoint).
        example: "300000000000000020"
        required: true
        schema:
          type: string
    put:
      summary: Update Scheduled Mass Message
      operationId: updateScheduledMassMessage
      description: Edit a pending scheduled broadcast. Fansly replaces the message on
        edit, so send the complete desired state — `text` and `scheduledFor`.
        Pass the existing `scheduledFor` (from the List Scheduled Mass Messages
        endpoint) to keep the schedule time unchanged.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data: broadcast sent
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055789
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: string
                    example: broadcast sent
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055789
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Mass Messaging
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: The message text content.
                  example: Hey everyone, new content is live! (edited)
                scheduledFor:
                  type: integer
                  description: Unix timestamp in milliseconds the broadcast is scheduled for. Pass
                    the current value to leave it unchanged.
                  example: 1785110912000
              required:
                - text
                - scheduledFor
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Add Users to List (/api-reference/fansly/lists/add-users-to-list)

Add one or more users/subscribers to a list.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/{fanslyAccount}/lists/{list_id}/items
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/lists/{list_id}/items:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: list_id
        description: The Fansly list ID.
        example: "853242689510977536"
        required: true
        schema:
          type: string
    post:
      summary: Add Users to List
      operationId: addUsersToList
      description: Add one or more users/subscribers to a list.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - id: "600000000000000001"
                      listId: "200000000000000001"
                      type: 1
                      metadata: ""
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055784
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: array
                    example:
                      - id: "600000000000000001"
                        listId: "200000000000000001"
                        type: 1
                        metadata: ""
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: "600000000000000001"
                        listId:
                          type: string
                          example: "200000000000000001"
                        type:
                          type: integer
                          example: 1
                        metadata:
                          type: string
                          example: ""
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055784
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Lists
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  description: Fansly user/subscriber IDs to add to the list.
                  example:
                    - "914611437760950272"
                  items:
                    type: string
                type:
                  type: integer
                  description: List item type code. Defaults to 1 (subscriber).
                  example: 1
              required:
                - ids
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Create List (/api-reference/fansly/lists/create-list)

Create a new subscriber/fan list.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/{fanslyAccount}/lists
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/lists:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Create List
      operationId: createList
      description: Create a new subscriber/fan list.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    accountId: "800000000000000001"
                    type: 1
                    label: Test list
                    id: "200000000000000003"
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055789
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      accountId:
                        type: string
                        example: "800000000000000001"
                      type:
                        type: integer
                        example: 1
                      label:
                        type: string
                        example: Test list
                      id:
                        type: string
                        example: "200000000000000003"
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055789
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Lists
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                label:
                  type: string
                  description: The name of the list.
                  example: VIPs
                type:
                  type: integer
                  description: List type code. Defaults to 1 (subscriber list).
                  example: 1
              required:
                - label
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Delete List (/api-reference/fansly/lists/delete-list)

Delete a list.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml delete /api/fansly/{fanslyAccount}/lists/{list_id}
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/lists/{list_id}:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: list_id
        description: The Fansly list ID.
        example: "918632596873703425"
        required: true
        schema:
          type: string
    delete:
      summary: Delete List
      operationId: deleteList
      description: Delete a list.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055786
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: string
                    example: null
                    nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055786
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Lists
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Items in List (/api-reference/fansly/lists/list-items-in-list)

Get the items (users/subscribers) in a list.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/lists/{list_id}/items
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/lists/{list_id}/items:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: list_id
        description: The Fansly list ID.
        example: "853242689510977536"
        required: true
        schema:
          type: string
    get:
      summary: List Items in List
      operationId: listItemsInList
      description: Get the items (users/subscribers) in a list.
      parameters:
        - in: query
          name: limit
          description: Number of items to return (1 - 100). Default = 50
          example: 50
          required: false
          schema:
            type: string
            description: Number of items to return (1 - 100). Default = 50
            example: 50
        - in: query
          name: sort_mode
          description: Native Fansly sort mode code. Default = 3 (most recently added
            first).
          example: 3
          required: false
          schema:
            type: string
            description: Native Fansly sort mode code. Default = 3 (most recently added
              first).
            example: 3
        - in: query
          name: after
          description: "Pagination cursor: the list item ID of the last item from the
            previous page. Omit for the first page."
          example: "875337282859593728"
          required: false
          schema:
            type: string
            description: "Pagination cursor: the list item ID of the last item from the
              previous page. Omit for the first page."
            example: "875337282859593728"
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - id: "600000000000000001"
                      sortId: "200000000000000010"
                      listId: "200000000000000001"
                      type: 1
                      metadata: ""
                    - id: "600000000000000002"
                      sortId: "200000000000000011"
                      listId: "200000000000000001"
                      type: 1
                      metadata: ""
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055785
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: array
                    example:
                      - id: "600000000000000001"
                        sortId: "200000000000000010"
                        listId: "200000000000000001"
                        type: 1
                        metadata: ""
                      - id: "600000000000000002"
                        sortId: "200000000000000011"
                        listId: "200000000000000001"
                        type: 1
                        metadata: ""
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: "600000000000000001"
                        sortId:
                          type: string
                          example: "200000000000000010"
                        listId:
                          type: string
                          example: "200000000000000001"
                        type:
                          type: integer
                          example: 1
                        metadata:
                          type: string
                          example: ""
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055785
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Lists
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Lists (/api-reference/fansly/lists/list-lists)

Get all subscriber/fan lists configured on the Fansly Account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/lists
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/lists:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Lists
      operationId: listLists
      description: Get all subscriber/fan lists configured on the Fansly Account.
      parameters:
        - in: query
          name: item_id
          description: Optional. Filter to lists that contain this user/subscriber ID.
          example: "700000000000000001"
          required: false
          schema:
            type: string
            description: Optional. Filter to lists that contain this user/subscriber ID.
            example: "700000000000000001"
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - id: "200000000000000001"
                      accountId: "800000000000000001"
                      pos: 0
                      type: 1
                      label: VIPs
                      itemCount: 8
                    - id: "200000000000000002"
                      accountId: "800000000000000001"
                      pos: 1
                      type: 1
                      label: Spenders
                      itemCount: 14
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055790
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: array
                    example:
                      - id: "200000000000000001"
                        accountId: "800000000000000001"
                        pos: 0
                        type: 1
                        label: VIPs
                        itemCount: 8
                      - id: "200000000000000002"
                        accountId: "800000000000000001"
                        pos: 1
                        type: 1
                        label: Spenders
                        itemCount: 14
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: "200000000000000001"
                        accountId:
                          type: string
                          example: "800000000000000001"
                        pos:
                          type: integer
                          example: 0
                        type:
                          type: integer
                          example: 1
                        label:
                          type: string
                          example: VIPs
                        itemCount:
                          type: integer
                          example: 8
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055790
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Lists
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Remove User from List (/api-reference/fansly/lists/remove-user-from-list)

Remove a user/subscriber from a list.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml delete /api/fansly/{fanslyAccount}/lists/{list_id}/items/{item_id}
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/lists/{list_id}/items/{item_id}:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: list_id
        description: The Fansly list ID.
        example: "862189259547750400"
        required: true
        schema:
          type: string
      - in: path
        name: item_id
        description: The Fansly list item ID (the user/subscriber ID in the list).
        example: "914611437760950272"
        required: true
        schema:
          type: string
    delete:
      summary: Remove User from List
      operationId: removeUserFromList
      description: Remove a user/subscriber from a list.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - "600000000000000001"
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055783
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: array
                    example:
                      - "600000000000000001"
                    items:
                      type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055783
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Lists
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Remove Users from List (/api-reference/fansly/lists/remove-users-from-list)

Remove one or more users/subscribers from a list in a single request.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml delete /api/fansly/{fanslyAccount}/lists/{list_id}/items
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/lists/{list_id}/items:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: list_id
        description: The Fansly list ID.
        example: "853242689510977536"
        required: true
        schema:
          type: string
    delete:
      summary: Remove Users from List
      operationId: removeUsersFromList
      description: Remove one or more users/subscribers from a list in a single request.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - "600000000000000001"
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055783
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: array
                    example:
                      - "600000000000000001"
                    items:
                      type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055783
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Lists
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  description: Fansly list item IDs (the user/subscriber IDs in the list) to
                    remove.
                  example:
                    - "914611437760950272"
                  items:
                    type: string
              required:
                - ids
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Reorder Lists (/api-reference/fansly/lists/reorder-lists)

Move a list from one position to another. Positions are zero-based, matching the Fansly Dashboard order.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/{fanslyAccount}/lists/reorder
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/lists/reorder:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Reorder Lists
      operationId: reorderLists
      description: Move a list from one position to another. Positions are zero-based,
        matching the Fansly Dashboard order.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055787
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: string
                    example: null
                    nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055787
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Lists
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                old_pos:
                  type: integer
                  description: Current position of the list.
                  example: 20
                new_pos:
                  type: integer
                  description: Target position for the list.
                  example: 19
              required:
                - old_pos
                - new_pos
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Update List (/api-reference/fansly/lists/update-list)

Update an existing list's label (and optionally type). To reorder lists, use the **Reorder Lists** endpoint.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml put /api/fansly/{fanslyAccount}/lists/{list_id}
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/lists/{list_id}:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: list_id
        description: The Fansly list ID.
        example: "918632596873703425"
        required: true
        schema:
          type: string
    put:
      summary: Update List
      operationId: updateList
      description: Update an existing list's label (and optionally type). To reorder
        lists, use the **Reorder Lists** endpoint.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: "200000000000000003"
                    accountId: "800000000000000001"
                    pos: null
                    type: 1
                    label: Test list (renamed)
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055788
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: "200000000000000003"
                      accountId:
                        type: string
                        example: "800000000000000001"
                      pos:
                        type: string
                        example: null
                        nullable: true
                      type:
                        type: integer
                        example: 1
                      label:
                        type: string
                        example: Test list (renamed)
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055788
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Lists
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                label:
                  type: string
                  description: The updated label.
                  example: VIPs (renamed)
                type:
                  type: integer
                  description: List type code. Defaults to 1.
                  example: 1
              required:
                - label
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Delete Post (/api-reference/fansly/posts/delete-post)

Delete a post from your account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml delete /api/fansly/{fanslyAccount}/posts/{post_id}
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/posts/{post_id}:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: post_id
        description: The Fansly post ID.
        example: "400000000000000001"
        required: true
        schema:
          type: string
    delete:
      summary: Delete Post
      operationId: deletePost
      description: Delete a post from your account.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055789
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: string
                    example: null
                    nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055789
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Posts
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Send Post (/api-reference/fansly/posts/send-post)

Compose and publish a new post. Provide `text`, one or more media IDs in `mediaFiles`, or both. Media must first be uploaded via the Upload Media endpoint (use the returned `fansly_media_` ID). Use `wallIds` (from the List Walls endpoint) to choose which walls the post is published to.

Attached media can be gated with any combination of the `requirePurchase`, `requireSubscription`, and `requireFollow` options (they stack — e.g. a media can require both a subscription and a purchase). The gating applies to all attached media: a single file, or the whole bundle when several are attached. When none of the gating options are sent, media is posted ungated (visible to anyone who can see the post).

Any attached media can be given a free preview — a separate media shown unlocked while the paid media is locked — via `previews`, a map of `mediaFiles` handle to preview handle.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/{fanslyAccount}/posts
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/posts:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Send Post
      operationId: sendPost
      description: >-
        Compose and publish a new post. Provide `text`, one or more media IDs in
        `mediaFiles`, or both. Media must first be uploaded via the Upload Media
        endpoint (use the returned `fansly_media_` ID). Use `wallIds` (from the
        List Walls endpoint) to choose which walls the post is published to.


        Attached media can be gated with any combination of the
        `requirePurchase`, `requireSubscription`, and `requireFollow` options
        (they stack — e.g. a media can require both a subscription and a
        purchase). The gating applies to all attached media: a single file, or
        the whole bundle when several are attached. When none of the gating
        options are sent, media is posted ungated (visible to anyone who can see
        the post).


        Any attached media can be given a free preview — a separate media shown
        unlocked while the paid media is locked — via `previews`, a map of
        `mediaFiles` handle to preview handle.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    accountId: "800000000000000001"
                    content: Hello everyone!
                    fypFlags: 0
                    inReplyTo: null
                    quotedPostId: null
                    replyPermissionFlags: 0
                    postReplyPermissionFlags: []
                    expiresAt: 1784301052641
                    attachments:
                      - contentType: 1
                        contentId: "500000000000000001"
                        pos: 0
                        postId: "400000000000000001"
                    wallIds:
                      - "200000000000000010"
                    pinWallIds: []
                    pinned: 0
                    id: "400000000000000001"
                    mediaLikeCount: 0
                    totalTipAmount: 0
                    attachmentTipAmount: 0
                    accountMentions: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055789
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      accountId:
                        type: string
                        example: "800000000000000001"
                      content:
                        type: string
                        example: Hello everyone!
                      fypFlags:
                        type: integer
                        example: 0
                      inReplyTo:
                        type: string
                        example: null
                        nullable: true
                      quotedPostId:
                        type: string
                        example: null
                        nullable: true
                      replyPermissionFlags:
                        type: integer
                        example: 0
                      postReplyPermissionFlags:
                        type: array
                        example: []
                      expiresAt:
                        type: integer
                        example: 1784301052641
                      attachments:
                        type: array
                        example:
                          - contentType: 1
                            contentId: "500000000000000001"
                            pos: 0
                            postId: "400000000000000001"
                        items:
                          type: object
                          properties:
                            contentType:
                              type: integer
                              example: 1
                            contentId:
                              type: string
                              example: "500000000000000001"
                            pos:
                              type: integer
                              example: 0
                            postId:
                              type: string
                              example: "400000000000000001"
                      wallIds:
                        type: array
                        example:
                          - "200000000000000010"
                        items:
                          type: string
                      pinWallIds:
                        type: array
                        example: []
                      pinned:
                        type: integer
                        example: 0
                      id:
                        type: string
                        example: "400000000000000001"
                      mediaLikeCount:
                        type: integer
                        example: 0
                      totalTipAmount:
                        type: integer
                        example: 0
                      attachmentTipAmount:
                        type: integer
                        example: 0
                      accountMentions:
                        type: array
                        example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055789
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Posts
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: The post text content. Required unless `mediaFiles` is provided.
                  example: Hello everyone!
                mediaFiles:
                  type: array
                  description: Media to attach, as `fansly_media_` upload IDs returned by the
                    Upload Media endpoint. A single item is attached on its own;
                    multiple are grouped into a bundle, in the given order.
                  example:
                    - fansly_media_01JR1234
                  items:
                    type: string
                wallIds:
                  type: array
                  description: Wall IDs to publish the post to. Refer to the List Walls endpoint.
                  example:
                    - "200000000000000010"
                  items:
                    type: string
                pinWallIds:
                  type: array
                  description: Wall IDs (from `wallIds`) the post should be pinned on.
                  example: []
                  items:
                    type: string
                expiresAt:
                  type: integer
                  description: Unix timestamp in milliseconds when the post should expire. Keep
                    empty for no expiration.
                  example: 1784301052641
                fypFlags:
                  type: integer
                  description: "For You Page behavior: 0 = post to the FYP if the post meets the
                    requirements (default), 4 = do not post to the FYP."
                  example: 0
                  enum:
                    - 0
                    - 4
                requirePurchase:
                  type: boolean
                  description: Require the fan to purchase (unlock) the attached media. Requires
                    `price`. Combinable with `requireSubscription` /
                    `requireFollow`.
                  example: false
                price:
                  type: integer
                  description: Unlock price for `requirePurchase`, in Fansly's smallest unit —
                    1000 = $1.00 (e.g. 10000 = $10.00). Required when
                    `requirePurchase` is true.
                  example: 10000
                requireSubscription:
                  type: boolean
                  description: Require the fan to be subscribed to view the attached media.
                    Combinable with `requirePurchase` / `requireFollow`.
                  example: false
                subscriptionTierId:
                  type: string
                  description: Restrict `requireSubscription` to a single subscription tier. Tier
                    IDs come from the List Subscription Tiers endpoint. Omit for
                    any tier.
                  example: "843584256474116096"
                requireFollow:
                  type: boolean
                  description: Require the fan to follow the account to view the attached media.
                    Combinable with `requirePurchase` / `requireSubscription`.
                  example: false
                previews:
                  type: object
                  description: Free previews for attached media, as a map of a `mediaFiles` handle
                    to a `fansly_media_` preview upload. Each preview is shown
                    unlocked while its (gated) media is locked. Only include
                    media that should have a preview.
                  example:
                    fansly_media_01JR1234: fansly_media_01JR5678
                  properties: {}
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Update Post (/api-reference/fansly/posts/update-post)

Edit an existing post. Fansly replaces the full post on edit, so send the complete desired state — `text`, `mediaFiles`, `wallIds`, `expiresAt` — not just the fields you are changing. Omitting `mediaFiles` removes the post's media; any provided media is re-registered and replaces the current attachments.

Attached media can be gated with any combination of the `requirePurchase`, `requireSubscription`, and `requireFollow` options (they stack), with an optional per-media free preview via `previews` — identical to the Send Post endpoint. Re-send the gating on edit; omitting it re-registers the media ungated.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml put /api/fansly/{fanslyAccount}/posts/{post_id}
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/posts/{post_id}:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: post_id
        description: The Fansly post ID.
        example: "400000000000000001"
        required: true
        schema:
          type: string
    put:
      summary: Update Post
      operationId: updatePost
      description: >-
        Edit an existing post. Fansly replaces the full post on edit, so send
        the complete desired state — `text`, `mediaFiles`, `wallIds`,
        `expiresAt` — not just the fields you are changing. Omitting
        `mediaFiles` removes the post's media; any provided media is
        re-registered and replaces the current attachments.


        Attached media can be gated with any combination of the
        `requirePurchase`, `requireSubscription`, and `requireFollow` options
        (they stack), with an optional per-media free preview via `previews` —
        identical to the Send Post endpoint. Re-send the gating on edit;
        omitting it re-registers the media ungated.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: "400000000000000001"
                    accountId: "800000000000000001"
                    content: Hello everyone! (edited)
                    fypFlags: 0
                    inReplyTo: null
                    inReplyToRoot: null
                    createdAt: 1784297503
                    expiresAt: 1784301052000
                    attachments:
                      - postId: "400000000000000001"
                        pos: 0
                        contentType: 1
                        contentId: "500000000000000001"
                        deletedAt: null
                    postReplyPermissionFlags: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055789
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: "400000000000000001"
                      accountId:
                        type: string
                        example: "800000000000000001"
                      content:
                        type: string
                        example: Hello everyone! (edited)
                      fypFlags:
                        type: integer
                        example: 0
                      inReplyTo:
                        type: string
                        example: null
                        nullable: true
                      inReplyToRoot:
                        type: string
                        example: null
                        nullable: true
                      createdAt:
                        type: integer
                        example: 1784297503
                      expiresAt:
                        type: integer
                        example: 1784301052000
                      attachments:
                        type: array
                        example:
                          - postId: "400000000000000001"
                            pos: 0
                            contentType: 1
                            contentId: "500000000000000001"
                            deletedAt: null
                        items:
                          type: object
                          properties:
                            postId:
                              type: string
                              example: "400000000000000001"
                            pos:
                              type: integer
                              example: 0
                            contentType:
                              type: integer
                              example: 1
                            contentId:
                              type: string
                              example: "500000000000000001"
                            deletedAt:
                              type: string
                              example: null
                              nullable: true
                      postReplyPermissionFlags:
                        type: array
                        example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055789
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Posts
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: The post text content. Required unless `mediaFiles` is provided.
                  example: Hello everyone! (edited)
                mediaFiles:
                  type: array
                  description: Media to attach, as `fansly_media_` upload IDs returned by the
                    Upload Media endpoint. A single item is attached on its own;
                    multiple are grouped into a bundle. Replaces the post's
                    current attachments.
                  example:
                    - fansly_media_01JR1234
                  items:
                    type: string
                wallIds:
                  type: array
                  description: Wall IDs the post should be published to. Refer to the List Walls
                    endpoint.
                  example:
                    - "200000000000000010"
                  items:
                    type: string
                pinWallIds:
                  type: array
                  description: Wall IDs (from `wallIds`) the post should be pinned on.
                  example: []
                  items:
                    type: string
                expiresAt:
                  type: integer
                  description: Unix timestamp in milliseconds when the post should expire. Keep
                    empty for no expiration.
                  example: 1784301052641
                fypFlags:
                  type: integer
                  description: "For You Page behavior: 0 = post to the FYP if the post meets the
                    requirements (default), 4 = do not post to the FYP."
                  example: 0
                  enum:
                    - 0
                    - 4
                requirePurchase:
                  type: boolean
                  description: Require the fan to purchase (unlock) the attached media. Requires
                    `price`. Combinable with `requireSubscription` /
                    `requireFollow`.
                  example: false
                price:
                  type: integer
                  description: Unlock price for `requirePurchase`, in Fansly's smallest unit —
                    1000 = $1.00 (e.g. 10000 = $10.00). Required when
                    `requirePurchase` is true.
                  example: 10000
                requireSubscription:
                  type: boolean
                  description: Require the fan to be subscribed to view the attached media.
                    Combinable with `requirePurchase` / `requireFollow`.
                  example: false
                subscriptionTierId:
                  type: string
                  description: Restrict `requireSubscription` to a single subscription tier. Tier
                    IDs come from the List Subscription Tiers endpoint. Omit for
                    any tier.
                  example: "843584256474116096"
                requireFollow:
                  type: boolean
                  description: Require the fan to follow the account to view the attached media.
                    Combinable with `requirePurchase` / `requireSubscription`.
                  example: false
                previews:
                  type: object
                  description: Free previews for attached media, as a map of a `mediaFiles` handle
                    to a `fansly_media_` preview upload. Each preview is shown
                    unlocked while its (gated) media is locked. Only include
                    media that should have a preview.
                  example:
                    fansly_media_01JR1234: fansly_media_01JR5678
                  properties: {}
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Account Media (/api-reference/fansly/media/get-account-media)

Fetch one or more registered accountMedia by ID (e.g. an `id` returned when attaching media to a message). Each item includes the full `media` object with variants and CDN `locations`. For video, poll this until `media.status` is `1` (transcode complete) — the playable variants and `locations` populate once processing finishes. Pass a single ID or a comma-separated list; bulk requests still cost one API credit.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/account-media/{ids}
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/account-media/{ids}:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: ids
        description: An accountMedia ID, or a comma-separated list of IDs.
        example: "925889499706191874"
        required: true
        schema:
          type: string
    get:
      summary: Get Account Media
      operationId: getAccountMedia
      description: Fetch one or more registered accountMedia by ID (e.g. an `id`
        returned when attaching media to a message). Each item includes the full
        `media` object with variants and CDN `locations`. For video, poll this
        until `media.status` is `1` (transcode complete) — the playable variants
        and `locations` populate once processing finishes. Pass a single ID or a
        comma-separated list; bulk requests still cost one API credit.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  response:
                    - id: "925889499706191874"
                      accountId: "800000000000000001"
                      mediaId: "925889471688232961"
                      previewId: null
                      permissionFlags: 8
                      price: 0
                      createdAt: 1782243618
                      deletedAt: null
                      deleted: false
                      permissions:
                        permissionFlags:
                          - id: "925889499710373888"
                            accountMediaId: "925889499706191874"
                            type: 0
                            flags: 8
                            price: 0
                            metadata: ""
                            validAfter: null
                            validBefore: null
                            verificationFlags: 8
                            verificationMetadata: "{}"
                        accountPermissionFlags:
                          flags: 255
                          metadata: "{}"
                      likeCount: 0
                      media:
                        id: "925889471688232961"
                        type: 2
                        status: 1
                        accountId: "800000000000000001"
                        mimetype: video/mp4
                        flags: 0
                        filename: clip.mp4
                        location: /800000000000000001/925889471688232961.mp4
                        width: 1280
                        height: 720
                        metadata: '{"originalHeight":720,"originalWidth":1280,"duration":3000,"resolutionMode":1,"frameRate":30}'
                        updatedAt: 1782244060
                        createdAt: 1782243612
                        variants:
                          - id: "925889471688232962"
                            type: 1
                            status: 1
                            mimetype: image/jpeg
                            flags: 0
                            filename: clip_frame.jpeg
                            location: /800000000000000001/925889471688232962.jpeg
                            width: 854
                            height: 480
                            metadata: '{"resolutionMode":1}'
                            updatedAt: 1782243645
                            locations:
                              - locationId: "1"
                                location: https://cdn3.fansly.com/800000000000000001/925889471688232962.jpeg?ngsw-bypass=true&Policy=EXAMPLE_POLICY&Key-Pair-Id=EXAMPLE_KEY&Signature=EXAMPLE_SIGNATURE
                          - id: "925889474821378050"
                            type: 302
                            status: 1
                            mimetype: application/vnd.apple.mpegurl
                            flags: 0
                            filename: 925889474821378050.m3u8
                            location: /800000000000000001/925889474821378050.m3u8
                            width: 1280
                            height: 720
                            metadata: '{"originalHeight":720,"originalWidth":1280,"duration":3000,"variants":[{"w":1280,"h":720},{"w":854,"h":480},{"w":640,"h":360}]}'
                            updatedAt: 1782244060
                            locations:
                              - locationId: "1"
                                location: https://cdn3.fansly.com/800000000000000001/925889474821378050.m3u8?ngsw-bypass=true&Policy=EXAMPLE_POLICY&Key-Pair-Id=EXAMPLE_KEY&Signature=EXAMPLE_SIGNATURE
                        variantHash: {}
                        locations:
                          - locationId: "1"
                            location: https://cdn3.fansly.com/800000000000000001/925889471688232961.mp4?ngsw-bypass=true&Policy=EXAMPLE_POLICY&Key-Pair-Id=EXAMPLE_KEY&Signature=EXAMPLE_SIGNATURE
                      whitelist:
                        - accountId: "800000000000000002"
                          permissionFlags: 0
                      purchased: true
                      whitelisted: true
                      accountPermissionFlags: 255
                      access: true
                properties:
                  success:
                    type: boolean
                    example: true
                  response:
                    type: array
                    example:
                      - id: "925889499706191874"
                        accountId: "800000000000000001"
                        mediaId: "925889471688232961"
                        previewId: null
                        permissionFlags: 8
                        price: 0
                        createdAt: 1782243618
                        deletedAt: null
                        deleted: false
                        permissions:
                          permissionFlags:
                            - id: "925889499710373888"
                              accountMediaId: "925889499706191874"
                              type: 0
                              flags: 8
                              price: 0
                              metadata: ""
                              validAfter: null
                              validBefore: null
                              verificationFlags: 8
                              verificationMetadata: "{}"
                          accountPermissionFlags:
                            flags: 255
                            metadata: "{}"
                        likeCount: 0
                        media:
                          id: "925889471688232961"
                          type: 2
                          status: 1
                          accountId: "800000000000000001"
                          mimetype: video/mp4
                          flags: 0
                          filename: clip.mp4
                          location: /800000000000000001/925889471688232961.mp4
                          width: 1280
                          height: 720
                          metadata: '{"originalHeight":720,"originalWidth":1280,"duration":3000,"resolutionMode":1,"frameRate":30}'
                          updatedAt: 1782244060
                          createdAt: 1782243612
                          variants:
                            - id: "925889471688232962"
                              type: 1
                              status: 1
                              mimetype: image/jpeg
                              flags: 0
                              filename: clip_frame.jpeg
                              location: /800000000000000001/925889471688232962.jpeg
                              width: 854
                              height: 480
                              metadata: '{"resolutionMode":1}'
                              updatedAt: 1782243645
                              locations:
                                - locationId: "1"
                                  location: https://cdn3.fansly.com/800000000000000001/925889471688232962.jpeg?ngsw-bypass=true&Policy=EXAMPLE_POLICY&Key-Pair-Id=EXAMPLE_KEY&Signature=EXAMPLE_SIGNATURE
                            - id: "925889474821378050"
                              type: 302
                              status: 1
                              mimetype: application/vnd.apple.mpegurl
                              flags: 0
                              filename: 925889474821378050.m3u8
                              location: /800000000000000001/925889474821378050.m3u8
                              width: 1280
                              height: 720
                              metadata: '{"originalHeight":720,"originalWidth":1280,"duration":3000,"variants":[{"w":1280,"h":720},{"w":854,"h":480},{"w":640,"h":360}]}'
                              updatedAt: 1782244060
                              locations:
                                - locationId: "1"
                                  location: https://cdn3.fansly.com/800000000000000001/925889474821378050.m3u8?ngsw-bypass=true&Policy=EXAMPLE_POLICY&Key-Pair-Id=EXAMPLE_KEY&Signature=EXAMPLE_SIGNATURE
                          variantHash: []
                          locations:
                            - locationId: "1"
                              location: https://cdn3.fansly.com/800000000000000001/925889471688232961.mp4?ngsw-bypass=true&Policy=EXAMPLE_POLICY&Key-Pair-Id=EXAMPLE_KEY&Signature=EXAMPLE_SIGNATURE
                        whitelist:
                          - accountId: "800000000000000002"
                            permissionFlags: 0
                        purchased: true
                        whitelisted: true
                        accountPermissionFlags: 255
                        access: true
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: "925889499706191874"
                        accountId:
                          type: string
                          example: "800000000000000001"
                        mediaId:
                          type: string
                          example: "925889471688232961"
                        previewId:
                          type: string
                          example: null
                          nullable: true
                        permissionFlags:
                          type: integer
                          example: 8
                        price:
                          type: integer
                          example: 0
                        createdAt:
                          type: integer
                          example: 1782243618
                        deletedAt:
                          type: string
                          example: null
                          nullable: true
                        deleted:
                          type: boolean
                          example: false
                        permissions:
                          type: object
                          properties:
                            permissionFlags:
                              type: array
                              example:
                                - id: "925889499710373888"
                                  accountMediaId: "925889499706191874"
                                  type: 0
                                  flags: 8
                                  price: 0
                                  metadata: ""
                                  validAfter: null
                                  validBefore: null
                                  verificationFlags: 8
                                  verificationMetadata: "{}"
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: "925889499710373888"
                                  accountMediaId:
                                    type: string
                                    example: "925889499706191874"
                                  type:
                                    type: integer
                                    example: 0
                                  flags:
                                    type: integer
                                    example: 8
                                  price:
                                    type: integer
                                    example: 0
                                  metadata:
                                    type: string
                                    example: ""
                                  validAfter:
                                    type: string
                                    example: null
                                    nullable: true
                                  validBefore:
                                    type: string
                                    example: null
                                    nullable: true
                                  verificationFlags:
                                    type: integer
                                    example: 8
                                  verificationMetadata:
                                    type: string
                                    example: "{}"
                            accountPermissionFlags:
                              type: object
                              properties:
                                flags:
                                  type: integer
                                  example: 255
                                metadata:
                                  type: string
                                  example: "{}"
                        likeCount:
                          type: integer
                          example: 0
                        media:
                          type: object
                          properties:
                            id:
                              type: string
                              example: "925889471688232961"
                            type:
                              type: integer
                              example: 2
                            status:
                              type: integer
                              example: 1
                            accountId:
                              type: string
                              example: "800000000000000001"
                            mimetype:
                              type: string
                              example: video/mp4
                            flags:
                              type: integer
                              example: 0
                            filename:
                              type: string
                              example: clip.mp4
                            location:
                              type: string
                              example: /800000000000000001/925889471688232961.mp4
                            width:
                              type: integer
                              example: 1280
                            height:
                              type: integer
                              example: 720
                            metadata:
                              type: string
                              example: '{"originalHeight":720,"originalWidth":1280,"duration":3000,"resolutionMode":1,"frameRate":30}'
                            updatedAt:
                              type: integer
                              example: 1782244060
                            createdAt:
                              type: integer
                              example: 1782243612
                            variants:
                              type: array
                              example:
                                - id: "925889471688232962"
                                  type: 1
                                  status: 1
                                  mimetype: image/jpeg
                                  flags: 0
                                  filename: clip_frame.jpeg
                                  location: /800000000000000001/925889471688232962.jpeg
                                  width: 854
                                  height: 480
                                  metadata: '{"resolutionMode":1}'
                                  updatedAt: 1782243645
                                  locations:
                                    - locationId: "1"
                                      location: https://cdn3.fansly.com/800000000000000001/925889471688232962.jpeg?ngsw-bypass=true&Policy=EXAMPLE_POLICY&Key-Pair-Id=EXAMPLE_KEY&Signature=EXAMPLE_SIGNATURE
                                - id: "925889474821378050"
                                  type: 302
                                  status: 1
                                  mimetype: application/vnd.apple.mpegurl
                                  flags: 0
                                  filename: 925889474821378050.m3u8
                                  location: /800000000000000001/925889474821378050.m3u8
                                  width: 1280
                                  height: 720
                                  metadata: '{"originalHeight":720,"originalWidth":1280,"duration":3000,"variants":[{"w":1280,"h":720},{"w":854,"h":480},{"w":640,"h":360}]}'
                                  updatedAt: 1782244060
                                  locations:
                                    - locationId: "1"
                                      location: https://cdn3.fansly.com/800000000000000001/925889474821378050.m3u8?ngsw-bypass=true&Policy=EXAMPLE_POLICY&Key-Pair-Id=EXAMPLE_KEY&Signature=EXAMPLE_SIGNATURE
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: "925889471688232962"
                                  type:
                                    type: integer
                                    example: 1
                                  status:
                                    type: integer
                                    example: 1
                                  mimetype:
                                    type: string
                                    example: image/jpeg
                                  flags:
                                    type: integer
                                    example: 0
                                  filename:
                                    type: string
                                    example: clip_frame.jpeg
                                  location:
                                    type: string
                                    example: /800000000000000001/925889471688232962.jpeg
                                  width:
                                    type: integer
                                    example: 854
                                  height:
                                    type: integer
                                    example: 480
                                  metadata:
                                    type: string
                                    example: '{"resolutionMode":1}'
                                  updatedAt:
                                    type: integer
                                    example: 1782243645
                                  locations:
                                    type: array
                                    example:
                                      - locationId: "1"
                                        location: https://cdn3.fansly.com/800000000000000001/925889471688232962.jpeg?ngsw-bypass=true&Policy=EXAMPLE_POLICY&Key-Pair-Id=EXAMPLE_KEY&Signature=EXAMPLE_SIGNATURE
                                    items:
                                      type: object
                                      properties:
                                        locationId:
                                          type: string
                                          example: "1"
                                        location:
                                          type: string
                                          example: https://cdn3.fansly.com/800000000000000001/925889471688232962.jpeg?ngsw-bypass=true&Policy=EXAMPLE_POLICY&Key-Pair-Id=EXAMPLE_KEY&Signature=EXAMPLE_SIGNATURE
                            variantHash:
                              type: object
                              properties: {}
                            locations:
                              type: array
                              example:
                                - locationId: "1"
                                  location: https://cdn3.fansly.com/800000000000000001/925889471688232961.mp4?ngsw-bypass=true&Policy=EXAMPLE_POLICY&Key-Pair-Id=EXAMPLE_KEY&Signature=EXAMPLE_SIGNATURE
                              items:
                                type: object
                                properties:
                                  locationId:
                                    type: string
                                    example: "1"
                                  location:
                                    type: string
                                    example: https://cdn3.fansly.com/800000000000000001/925889471688232961.mp4?ngsw-bypass=true&Policy=EXAMPLE_POLICY&Key-Pair-Id=EXAMPLE_KEY&Signature=EXAMPLE_SIGNATURE
                        whitelist:
                          type: array
                          example:
                            - accountId: "800000000000000002"
                              permissionFlags: 0
                          items:
                            type: object
                            properties:
                              accountId:
                                type: string
                                example: "800000000000000002"
                              permissionFlags:
                                type: integer
                                example: 0
                        purchased:
                          type: boolean
                          example: true
                        whitelisted:
                          type: boolean
                          example: true
                        accountPermissionFlags:
                          type: integer
                          example: 255
                        access:
                          type: boolean
                          example: true
      tags:
        - Media
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Upload Status (/api-reference/fansly/media/get-upload-status)

Check the status of an async Fansly media upload. Poll until status is `completed` or `failed`. This endpoint is free and does not cost any credits.

**Possible statuses:**

* `pending` — Upload is queued
* `processing` — Upload in progress
* `completed` — Upload finished, `media_id` and `media` are included
* `failed` — Upload failed, `error` is included

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/media/uploads/{upload}/status
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/media/uploads/{upload}/status:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: upload
        description: The prefixed ID of the upload.
        example: fansly_media_01JR1234
        required: true
        schema:
          type: string
    get:
      summary: Get Upload Status
      operationId: getUploadStatus
      description: >-
        Check the status of an async Fansly media upload. Poll until status is
        `completed` or `failed`. This endpoint is free and does not cost any
        credits.


        **Possible statuses:**

        - `pending` — Upload is queued

        - `processing` — Upload in progress

        - `completed` — Upload finished, `media_id` and `media` are included

        - `failed` — Upload failed, `error` is included
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                oneOf:
                  - description: Upload still processing
                    type: object
                    example:
                      status: processing
                      prefixed_id: fansly_media_01JR1234
                    properties:
                      status:
                        type: string
                        example: processing
                      prefixed_id:
                        type: string
                        example: fansly_media_01JR1234
                  - description: Upload failed
                    type: object
                    example:
                      status: failed
                      prefixed_id: fansly_media_01JR1234
                      error: Failed to download file from the provided URL.
                    properties:
                      status:
                        type: string
                        example: failed
                      prefixed_id:
                        type: string
                        example: fansly_media_01JR1234
                      error:
                        type: string
                        example: Failed to download file from the provided URL.
                  - description: Completed upload
                    type: object
                    example:
                      status: completed
                      prefixed_id: fansly_media_01JR1234ABCD5678EFGH
                      media_id: "800000000000000010"
                      media:
                        id: "800000000000000010"
                        type: 1
                        status: 1
                        accountId: "800000000000000001"
                        mimetype: image/jpeg
                        filename: photo.jpg
                        width: 1080
                        height: 1080
                      credits_used: 1
                    properties:
                      status:
                        type: string
                        example: completed
                      prefixed_id:
                        type: string
                        example: fansly_media_01JR1234ABCD5678EFGH
                      media_id:
                        type: string
                        example: "800000000000000010"
                      media:
                        type: object
                        properties:
                          id:
                            type: string
                            example: "800000000000000010"
                          type:
                            type: integer
                            example: 1
                          status:
                            type: integer
                            example: 1
                          accountId:
                            type: string
                            example: "800000000000000001"
                          mimetype:
                            type: string
                            example: image/jpeg
                          filename:
                            type: string
                            example: photo.jpg
                          width:
                            type: integer
                            example: 1080
                          height:
                            type: integer
                            example: 1080
                      credits_used:
                        type: integer
                        example: 1
      tags:
        - Media
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Upload Media (/api-reference/fansly/media/upload-media)

Upload a file to Fansly and receive a reusable `fansly_media_` ID that can be attached to chat messages (and, later, posts). Provide either `file` or `file_url`. Credits are charged per megabyte uploaded.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/{fanslyAccount}/media/upload
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/media/upload:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Upload Media
      operationId: uploadMedia
      description: Upload a file to Fansly and receive a reusable `fansly_media_` ID
        that can be attached to chat messages (and, later, posts). Provide
        either `file` or `file_url`. Credits are charged per megabyte uploaded.
      parameters: []
      responses:
        "200":
          description: Synchronous upload (default)
          content:
            application/json:
              schema:
                type: object
                example:
                  prefixed_id: fansly_media_01JR1234ABCD5678EFGH
                  file_name: photo.jpg
                  media_id: "800000000000000010"
                  media:
                    id: "800000000000000010"
                    type: 1
                    status: 1
                    accountId: "800000000000000001"
                    mimetype: image/jpeg
                    filename: photo.jpg
                    width: 1080
                    height: 1080
                  credits_used: 1
                properties:
                  prefixed_id:
                    type: string
                    example: fansly_media_01JR1234ABCD5678EFGH
                  file_name:
                    type: string
                    example: photo.jpg
                  media_id:
                    type: string
                    example: "800000000000000010"
                  media:
                    type: object
                    properties:
                      id:
                        type: string
                        example: "800000000000000010"
                      type:
                        type: integer
                        example: 1
                      status:
                        type: integer
                        example: 1
                      accountId:
                        type: string
                        example: "800000000000000001"
                      mimetype:
                        type: string
                        example: image/jpeg
                      filename:
                        type: string
                        example: photo.jpg
                      width:
                        type: integer
                        example: 1080
                      height:
                        type: integer
                        example: 1080
                  credits_used:
                    type: integer
                    example: 1
        "202":
          description: Async upload (async=true)
          content:
            application/json:
              schema:
                type: object
                example:
                  status: pending
                  prefixed_id: fansly_media_01JR1234ABCD5678EFGH
                  polling_url: https://app.onlyfansapi.com/api/fansly/fansly_acct_XXXXXXXXXXXXXXX/media/uploads/fansly_media_01JR1234ABCD5678EFGH/status
                properties:
                  status:
                    type: string
                    example: pending
                  prefixed_id:
                    type: string
                    example: fansly_media_01JR1234ABCD5678EFGH
                  polling_url:
                    type: string
                    example: https://app.onlyfansapi.com/api/fansly/fansly_acct_XXXXXXXXXXXXXXX/media/uploads/fansly_media_01JR1234ABCD5678EFGH/status
      tags:
        - Media
      requestBody:
        required: false
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                  description: "The file to upload. Required if `file_url` is not provided.
                    Maximum file size: 100 MB."
                file_url:
                  type: string
                  description: A URL to download the file from. Required if `file` is not
                    provided.
                  example: https://example.com/media/photo.jpg
                async:
                  type: boolean
                  description: Set to `true` to process the upload in the background. Returns a
                    `polling_url` to check status. Recommended for large
                    files/videos.
                  example: true
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Insights (/api-reference/fansly/profile-statistics/get-insights)

Get viewer engagement insights for the Fansly Account — views, interaction time, unique viewers, and video stats — bucketed by the granularity of the chosen range.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/insights
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/insights:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Insights
      operationId: getInsights
      description: Get viewer engagement insights for the Fansly Account — views,
        interaction time, unique viewers, and video stats — bucketed by the
        granularity of the chosen range.
      parameters:
        - in: query
          name: range
          description: Time range for the report. Default = last_30_days. Each range
            determines the bucket size (5min / 1h / 6h / 1d).
          example: last_30_days
          required: false
          schema:
            type: string
            description: Time range for the report. Default = last_30_days. Each range
              determines the bucket size (5min / 1h / 6h / 1d).
            example: last_30_days
            enum:
              - last_hour
              - last_24h
              - last_7_days
              - last_30_days
              - month
        - in: query
          name: month
          description: "Required when `range=month`. Format: YYYY-MM (e.g. `2026-05`).
            Ignored for other ranges."
          example: 2026-05
          required: false
          schema:
            type: string
            description: "Required when `range=month`. Format: YYYY-MM (e.g. `2026-05`).
              Ignored for other ranges."
            example: 2026-05
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    dataset:
                      period: 86400000
                      dateBefore: 1780444800000
                      dateAfter: 1777852800000
                      datapointLimit: 100
                      datapoints:
                        - timestamp: 1780444800000
                          stats:
                            - type: 0
                              views: 672
                              previewViews: 0
                              interactionTime: 2459162
                              previewInteractionTime: 0
                              uniqueViewers: 431
                              previewUniqueViewers: 0
                              videoViews: 672
                              totalVideoPercentWatched: 184.62
                              previewVideoViews: 0
                              previewTotalVideoPercentWatched: 0
                            - type: 1
                              views: 394
                              previewViews: 3
                              interactionTime: 4685121
                              previewInteractionTime: 2014
                              uniqueViewers: 128
                              previewUniqueViewers: 1
                              videoViews: 263
                              totalVideoPercentWatched: 128.59
                              previewVideoViews: 0
                              previewTotalVideoPercentWatched: 0
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055780
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      dataset:
                        type: object
                        properties:
                          period:
                            type: integer
                            example: 86400000
                          dateBefore:
                            type: integer
                            example: 1780444800000
                          dateAfter:
                            type: integer
                            example: 1777852800000
                          datapointLimit:
                            type: integer
                            example: 100
                          datapoints:
                            type: array
                            example:
                              - timestamp: 1780444800000
                                stats:
                                  - type: 0
                                    views: 672
                                    previewViews: 0
                                    interactionTime: 2459162
                                    previewInteractionTime: 0
                                    uniqueViewers: 431
                                    previewUniqueViewers: 0
                                    videoViews: 672
                                    totalVideoPercentWatched: 184.62
                                    previewVideoViews: 0
                                    previewTotalVideoPercentWatched: 0
                                  - type: 1
                                    views: 394
                                    previewViews: 3
                                    interactionTime: 4685121
                                    previewInteractionTime: 2014
                                    uniqueViewers: 128
                                    previewUniqueViewers: 1
                                    videoViews: 263
                                    totalVideoPercentWatched: 128.59
                                    previewVideoViews: 0
                                    previewTotalVideoPercentWatched: 0
                            items:
                              type: object
                              properties:
                                timestamp:
                                  type: integer
                                  example: 1780444800000
                                stats:
                                  type: array
                                  example:
                                    - type: 0
                                      views: 672
                                      previewViews: 0
                                      interactionTime: 2459162
                                      previewInteractionTime: 0
                                      uniqueViewers: 431
                                      previewUniqueViewers: 0
                                      videoViews: 672
                                      totalVideoPercentWatched: 184.62
                                      previewVideoViews: 0
                                      previewTotalVideoPercentWatched: 0
                                    - type: 1
                                      views: 394
                                      previewViews: 3
                                      interactionTime: 4685121
                                      previewInteractionTime: 2014
                                      uniqueViewers: 128
                                      previewUniqueViewers: 1
                                      videoViews: 263
                                      totalVideoPercentWatched: 128.59
                                      previewVideoViews: 0
                                      previewTotalVideoPercentWatched: 0
                                  items:
                                    type: object
                                    properties:
                                      type:
                                        type: integer
                                        example: 0
                                      views:
                                        type: integer
                                        example: 672
                                      previewViews:
                                        type: integer
                                        example: 0
                                      interactionTime:
                                        type: integer
                                        example: 2459162
                                      previewInteractionTime:
                                        type: integer
                                        example: 0
                                      uniqueViewers:
                                        type: integer
                                        example: 431
                                      previewUniqueViewers:
                                        type: integer
                                        example: 0
                                      videoViews:
                                        type: integer
                                        example: 672
                                      totalVideoPercentWatched:
                                        type: number
                                        example: 184.62
                                      previewVideoViews:
                                        type: integer
                                        example: 0
                                      previewTotalVideoPercentWatched:
                                        type: integer
                                        example: 0
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055780
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Profile Statistics
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Subscribers (/api-reference/fansly/subscribers/list-subscribers)

Get the list of subscribers for a Fansly Account, including their subscription tier, price, billing cycle, and lifecycle timestamps.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/subscribers
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/subscribers:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Subscribers
      operationId: listSubscribers
      description: Get the list of subscribers for a Fansly Account, including their
        subscription tier, price, billing cycle, and lifecycle timestamps.
      parameters:
        - in: query
          name: limit
          description: Number of subscribers to return (1 - 100). Default = 20
          example: 20
          required: false
          schema:
            type: string
            description: Number of subscribers to return (1 - 100). Default = 20
            example: 20
        - in: query
          name: offset
          description: Number of subscribers to skip for pagination. Default = 0
          example: 0
          required: false
          schema:
            type: string
            description: Number of subscribers to skip for pagination. Default = 0
            example: 0
        - in: query
          name: search
          description: Search subscribers by username/display name
          example: ""
          required: false
          schema:
            type: string
            description: Search subscribers by username/display name
            example: ""
        - in: query
          name: subscription_tier_id
          description: Filter to subscribers on a single subscription tier. Tier IDs can
            be obtained from the **List Subscription Tiers** endpoint.
          example: "843584256474116096"
          required: false
          schema:
            type: string
            description: Filter to subscribers on a single subscription tier. Tier IDs can
              be obtained from the **List Subscription Tiers** endpoint.
            example: "843584256474116096"
        - in: query
          name: status
          description: Subscription status filter. Default = active
          example: active
          required: false
          schema:
            type: string
            description: Subscription status filter. Default = active
            example: active
            enum:
              - active
              - expired
              - all
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    stats:
                      totalActive: 2
                      totalExpired: 1
                      total: 3
                    subscriptions:
                      - id: "500000000000000001"
                        historyId: "500000000000000002"
                        subscriberId: "600000000000000001"
                        subscriptionTierId: "700000000000000001"
                        subscriptionTierName: Starter Tier
                        subscriptionTierColor: "#FF6F61"
                        planId: "700000000000000010"
                        promoId: "0"
                        giftCodeId: null
                        paymentMethodId: "0"
                        status: 3
                        price: 5000
                        renewPrice: 5000
                        renewCorrelationId: "500000000000000002"
                        autoRenew: 1
                        billingCycle: 30
                        duration: 30
                        renewDate: 1780479709000
                        version: 3
                        createdAt: 1780479709000
                        updatedAt: 1780479710000
                        endsAt: 1783071709000
                        promoPrice: null
                        promoDuration: null
                        promoStatus: null
                        promoStartsAt: null
                        promoEndsAt: null
                      - id: "500000000000000003"
                        historyId: "500000000000000004"
                        subscriberId: "600000000000000002"
                        subscriptionTierId: "700000000000000002"
                        subscriptionTierName: Premium Tier
                        subscriptionTierColor: "#FF69B4"
                        planId: "700000000000000020"
                        promoId: "0"
                        giftCodeId: null
                        paymentMethodId: "0"
                        status: 4
                        price: 99000
                        renewPrice: 99000
                        renewCorrelationId: "500000000000000004"
                        autoRenew: 0
                        billingCycle: 30
                        duration: 30
                        renewDate: 1780433433000
                        version: 4
                        createdAt: 1780433433000
                        updatedAt: 1780433434000
                        endsAt: 1783025433000
                        promoPrice: null
                        promoDuration: null
                        promoStatus: null
                        promoStartsAt: null
                        promoEndsAt: null
                    hasMore: false
                  _pagination:
                    next_page: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055811
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      stats:
                        type: object
                        properties:
                          totalActive:
                            type: integer
                            example: 2
                          totalExpired:
                            type: integer
                            example: 1
                          total:
                            type: integer
                            example: 3
                      subscriptions:
                        type: array
                        example:
                          - id: "500000000000000001"
                            historyId: "500000000000000002"
                            subscriberId: "600000000000000001"
                            subscriptionTierId: "700000000000000001"
                            subscriptionTierName: Starter Tier
                            subscriptionTierColor: "#FF6F61"
                            planId: "700000000000000010"
                            promoId: "0"
                            giftCodeId: null
                            paymentMethodId: "0"
                            status: 3
                            price: 5000
                            renewPrice: 5000
                            renewCorrelationId: "500000000000000002"
                            autoRenew: 1
                            billingCycle: 30
                            duration: 30
                            renewDate: 1780479709000
                            version: 3
                            createdAt: 1780479709000
                            updatedAt: 1780479710000
                            endsAt: 1783071709000
                            promoPrice: null
                            promoDuration: null
                            promoStatus: null
                            promoStartsAt: null
                            promoEndsAt: null
                          - id: "500000000000000003"
                            historyId: "500000000000000004"
                            subscriberId: "600000000000000002"
                            subscriptionTierId: "700000000000000002"
                            subscriptionTierName: Premium Tier
                            subscriptionTierColor: "#FF69B4"
                            planId: "700000000000000020"
                            promoId: "0"
                            giftCodeId: null
                            paymentMethodId: "0"
                            status: 4
                            price: 99000
                            renewPrice: 99000
                            renewCorrelationId: "500000000000000004"
                            autoRenew: 0
                            billingCycle: 30
                            duration: 30
                            renewDate: 1780433433000
                            version: 4
                            createdAt: 1780433433000
                            updatedAt: 1780433434000
                            endsAt: 1783025433000
                            promoPrice: null
                            promoDuration: null
                            promoStatus: null
                            promoStartsAt: null
                            promoEndsAt: null
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: "500000000000000001"
                            historyId:
                              type: string
                              example: "500000000000000002"
                            subscriberId:
                              type: string
                              example: "600000000000000001"
                            subscriptionTierId:
                              type: string
                              example: "700000000000000001"
                            subscriptionTierName:
                              type: string
                              example: Starter Tier
                            subscriptionTierColor:
                              type: string
                              example: "#FF6F61"
                            planId:
                              type: string
                              example: "700000000000000010"
                            promoId:
                              type: string
                              example: "0"
                            giftCodeId:
                              type: string
                              example: null
                              nullable: true
                            paymentMethodId:
                              type: string
                              example: "0"
                            status:
                              type: integer
                              example: 3
                            price:
                              type: integer
                              example: 5000
                            renewPrice:
                              type: integer
                              example: 5000
                            renewCorrelationId:
                              type: string
                              example: "500000000000000002"
                            autoRenew:
                              type: integer
                              example: 1
                            billingCycle:
                              type: integer
                              example: 30
                            duration:
                              type: integer
                              example: 30
                            renewDate:
                              type: integer
                              example: 1780479709000
                            version:
                              type: integer
                              example: 3
                            createdAt:
                              type: integer
                              example: 1780479709000
                            updatedAt:
                              type: integer
                              example: 1780479710000
                            endsAt:
                              type: integer
                              example: 1783071709000
                            promoPrice:
                              type: string
                              example: null
                              nullable: true
                            promoDuration:
                              type: string
                              example: null
                              nullable: true
                            promoStatus:
                              type: string
                              example: null
                              nullable: true
                            promoStartsAt:
                              type: string
                              example: null
                              nullable: true
                            promoEndsAt:
                              type: string
                              example: null
                              nullable: true
                      hasMore:
                        type: boolean
                        example: false
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: null
                        nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055811
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Subscribers
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Subscription Tiers (/api-reference/fansly/subscribers/list-subscription-tiers)

Get all subscription tiers configured on the Fansly Account, including pricing plans and benefits. Tier IDs from this endpoint can be used as the `subscription_tier_id` filter on the **List Subscribers** endpoint.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/subscription-tiers
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/subscription-tiers:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Subscription Tiers
      operationId: listSubscriptionTiers
      description: Get all subscription tiers configured on the Fansly Account,
        including pricing plans and benefits. Tier IDs from this endpoint can be
        used as the `subscription_tier_id` filter on the **List Subscribers**
        endpoint.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - id: "700000000000000001"
                      accountId: "800000000000000001"
                      name: Starter Tier
                      color: "#FF6F61"
                      pos: 0
                      price: 5000
                      maxSubscribers: 0
                      subscriptionBenefits:
                        - Access to all photos and videos on the wall
                        - Chat access
                      includedTierIds: []
                      plans:
                        - id: "700000000000000010"
                          status: 1
                          billingCycle: 30
                          price: 5000
                          useAmounts: 0
                          promos: []
                        - id: "700000000000000011"
                          status: 1
                          billingCycle: 90
                          price: 13500
                          useAmounts: 0
                          promos: []
                    - id: "700000000000000002"
                      accountId: "800000000000000001"
                      name: Premium Tier
                      color: "#FF69B4"
                      pos: 1
                      price: 99000
                      maxSubscribers: 0
                      subscriptionBenefits:
                        - All Starter benefits
                        - Bonus content drops
                      includedTierIds:
                        - "700000000000000001"
                      plans:
                        - id: "700000000000000020"
                          status: 1
                          billingCycle: 30
                          price: 99000
                          useAmounts: 0
                          promos: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055810
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: array
                    example:
                      - id: "700000000000000001"
                        accountId: "800000000000000001"
                        name: Starter Tier
                        color: "#FF6F61"
                        pos: 0
                        price: 5000
                        maxSubscribers: 0
                        subscriptionBenefits:
                          - Access to all photos and videos on the wall
                          - Chat access
                        includedTierIds: []
                        plans:
                          - id: "700000000000000010"
                            status: 1
                            billingCycle: 30
                            price: 5000
                            useAmounts: 0
                            promos: []
                          - id: "700000000000000011"
                            status: 1
                            billingCycle: 90
                            price: 13500
                            useAmounts: 0
                            promos: []
                      - id: "700000000000000002"
                        accountId: "800000000000000001"
                        name: Premium Tier
                        color: "#FF69B4"
                        pos: 1
                        price: 99000
                        maxSubscribers: 0
                        subscriptionBenefits:
                          - All Starter benefits
                          - Bonus content drops
                        includedTierIds:
                          - "700000000000000001"
                        plans:
                          - id: "700000000000000020"
                            status: 1
                            billingCycle: 30
                            price: 99000
                            useAmounts: 0
                            promos: []
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: "700000000000000001"
                        accountId:
                          type: string
                          example: "800000000000000001"
                        name:
                          type: string
                          example: Starter Tier
                        color:
                          type: string
                          example: "#FF6F61"
                        pos:
                          type: integer
                          example: 0
                        price:
                          type: integer
                          example: 5000
                        maxSubscribers:
                          type: integer
                          example: 0
                        subscriptionBenefits:
                          type: array
                          example:
                            - Access to all photos and videos on the wall
                            - Chat access
                          items:
                            type: string
                        includedTierIds:
                          type: array
                          example: []
                        plans:
                          type: array
                          example:
                            - id: "700000000000000010"
                              status: 1
                              billingCycle: 30
                              price: 5000
                              useAmounts: 0
                              promos: []
                            - id: "700000000000000011"
                              status: 1
                              billingCycle: 90
                              price: 13500
                              useAmounts: 0
                              promos: []
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: "700000000000000010"
                              status:
                                type: integer
                                example: 1
                              billingCycle:
                                type: integer
                                example: 30
                              price:
                                type: integer
                                example: 5000
                              useAmounts:
                                type: integer
                                example: 0
                              promos:
                                type: array
                                example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055810
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Subscribers
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Top Supporter Breakdown (/api-reference/fansly/top-supporters/get-top-supporter-breakdown)

Get earnings broken down by transaction type for a specific supporter, showing how they contributed revenue within a date range.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/top-supporters/{account_id}
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/top-supporters/{account_id}:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: account_id
        description: The Fansly account ID of the supporter (the `correlationAccountId`
          from the **List Top Supporters** response).
        example: "847765080337555456"
        required: true
        schema:
          type: string
    get:
      summary: Get Top Supporter Breakdown
      operationId: getTopSupporterBreakdown
      description: Get earnings broken down by transaction type for a specific
        supporter, showing how they contributed revenue within a date range.
      parameters:
        - in: query
          name: before
          description: End of the date range (ISO 8601). Defaults to now.
          example: 2026-06-03T23:59:59Z
          required: false
          schema:
            type: string
            description: End of the date range (ISO 8601). Defaults to now.
            example: 2026-06-03T23:59:59Z
        - in: query
          name: after
          description: Start of the date range (ISO 8601). Defaults to 30 days ago.
          example: 2026-05-03T00:00:00Z
          required: false
          schema:
            type: string
            description: Start of the date range (ISO 8601). Defaults to 30 days ago.
            example: 2026-05-03T00:00:00Z
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - type: 2116
                      totalGross: 5000
                      totalNet: 4000
                      accountId: "800000000000000001"
                      correlationAccountId: "900000000000000010"
                      timestamp: 1780358400000
                    - type: 15001
                      totalGross: 99000
                      totalNet: 79200
                      accountId: "800000000000000001"
                      correlationAccountId: "900000000000000010"
                      timestamp: 1780444800000
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055759
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: array
                    example:
                      - type: 2116
                        totalGross: 5000
                        totalNet: 4000
                        accountId: "800000000000000001"
                        correlationAccountId: "900000000000000010"
                        timestamp: 1780358400000
                      - type: 15001
                        totalGross: 99000
                        totalNet: 79200
                        accountId: "800000000000000001"
                        correlationAccountId: "900000000000000010"
                        timestamp: 1780444800000
                    items:
                      type: object
                      properties:
                        type:
                          type: integer
                          example: 2116
                        totalGross:
                          type: integer
                          example: 5000
                        totalNet:
                          type: integer
                          example: 4000
                        accountId:
                          type: string
                          example: "800000000000000001"
                        correlationAccountId:
                          type: string
                          example: "900000000000000010"
                        timestamp:
                          type: integer
                          example: 1780358400000
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055759
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Top Supporters
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Top Supporters (/api-reference/fansly/top-supporters/list-top-supporters)

Get supporters ranked by total revenue contribution within a date range, with gross/net totals.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/top-supporters
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/top-supporters:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Top Supporters
      operationId: listTopSupporters
      description: Get supporters ranked by total revenue contribution within a date
        range, with gross/net totals.
      parameters:
        - in: query
          name: before
          description: End of the date range (ISO 8601). Defaults to now.
          example: 2026-06-03T23:59:59Z
          required: false
          schema:
            type: string
            description: End of the date range (ISO 8601). Defaults to now.
            example: 2026-06-03T23:59:59Z
        - in: query
          name: after
          description: Start of the date range (ISO 8601). Defaults to 30 days ago.
          example: 2026-05-03T00:00:00Z
          required: false
          schema:
            type: string
            description: Start of the date range (ISO 8601). Defaults to 30 days ago.
            example: 2026-05-03T00:00:00Z
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - totalGross: 163990
                      totalNet: 131192
                      accountId: "800000000000000001"
                      correlationAccountId: "900000000000000010"
                    - totalGross: 100000
                      totalNet: 80000
                      accountId: "800000000000000001"
                      correlationAccountId: "900000000000000011"
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055760
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: array
                    example:
                      - totalGross: 163990
                        totalNet: 131192
                        accountId: "800000000000000001"
                        correlationAccountId: "900000000000000010"
                      - totalGross: 100000
                        totalNet: 80000
                        accountId: "800000000000000001"
                        correlationAccountId: "900000000000000011"
                    items:
                      type: object
                      properties:
                        totalGross:
                          type: integer
                          example: 163990
                        totalNet:
                          type: integer
                          example: 131192
                        accountId:
                          type: string
                          example: "800000000000000001"
                        correlationAccountId:
                          type: string
                          example: "900000000000000010"
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055760
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Top Supporters
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Create Subscription Discount (/api-reference/fansly/subscription-discounts/create-subscription-discount)

Create a new subscription discount (gift link).

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/{fanslyAccount}/subscription-discounts
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/subscription-discounts:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Create Subscription Discount
      operationId: createSubscriptionDiscount
      description: Create a new subscription discount (gift link).
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: "900000000000000003"
                    type: 1
                    label: ""
                    planId: "700000000000000010"
                    accountId: "800000000000000001"
                    price: 5000
                    paymentMethodRequired: 0
                    duration: 7
                    maxUses: 100
                    newSubscribersOnly: 1
                    startsAt: 0
                    endsAt: 0
                    status: 1
                    originalPrice: 5000
                    code: OTAwMDAwMDAwMDAwMDAwMDAzOjE6MTpiMzAxMjJiODZk
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055789
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: "900000000000000003"
                      type:
                        type: integer
                        example: 1
                      label:
                        type: string
                        example: ""
                      planId:
                        type: string
                        example: "700000000000000010"
                      accountId:
                        type: string
                        example: "800000000000000001"
                      price:
                        type: integer
                        example: 5000
                      paymentMethodRequired:
                        type: integer
                        example: 0
                      duration:
                        type: integer
                        example: 7
                      maxUses:
                        type: integer
                        example: 100
                      newSubscribersOnly:
                        type: integer
                        example: 1
                      startsAt:
                        type: integer
                        example: 0
                      endsAt:
                        type: integer
                        example: 0
                      status:
                        type: integer
                        example: 1
                      originalPrice:
                        type: integer
                        example: 5000
                      code:
                        type: string
                        example: OTAwMDAwMDAwMDAwMDAwMDAzOjE6MTpiMzAxMjJiODZk
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055789
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Subscription Discounts
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                plan_id:
                  type: string
                  description: The subscription plan ID this discount renews for. Plan IDs come
                    from the **List Subscription Tiers** endpoint
                    (`tiers[].plans[].id`).
                  example: "843584256495083520"
                price:
                  type: integer
                  description: Discounted price in cents (e.g. 5000 = $5.00).
                  example: 5000
                duration:
                  type: integer
                  description: Duration in days until the subscriber rebills at the full
                    subscription price.
                  example: 7
                label:
                  type: string
                  description: Optional internal label for the discount.
                  example: Launch Week – 50% OFF
                max_uses:
                  type: integer
                  description: Maximum number of times the discount can be claimed. Default = 100.
                  example: 100
                new_subscribers_only:
                  type: integer
                  description: Set to 1 to exclude users who have already claimed a discount for
                    this plan, 0 to allow everyone. Default = 1.
                  example: 1
                starts_at:
                  type: integer
                  description: Optional start time as a UTC epoch in milliseconds. 0 (default)
                    means active immediately.
                  example: 1782737160000
                ends_at:
                  type: integer
                  description: Optional end time as a UTC epoch in milliseconds. 0 (default) means
                    no expiry.
                  example: 1782823560000
              required:
                - plan_id
                - price
                - duration
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Disable Subscription Discount (/api-reference/fansly/subscription-discounts/disable-subscription-discount)

Disable (deactivate) a subscription discount. It can be re-enabled later with the **Enable Subscription Discount** endpoint.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/{fanslyAccount}/subscription-discounts/{discount_id}/disable
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/subscription-discounts/{discount_id}/disable:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: discount_id
        description: The Fansly subscription discount (gift code) ID.
        example: "927958667997761536"
        required: true
        schema:
          type: string
    post:
      summary: Disable Subscription Discount
      operationId: disableSubscriptionDiscount
      description: Disable (deactivate) a subscription discount. It can be re-enabled
        later with the **Enable Subscription Discount** endpoint.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: "900000000000000003"
                    type: 1
                    label: new link
                    planId: "700000000000000010"
                    accountId: "800000000000000001"
                    price: 5000
                    paymentMethodRequired: 0
                    duration: 7
                    maxUses: 100
                    newSubscribersOnly: 1
                    startsAt: 0
                    endsAt: 0
                    status: 2
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055787
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: "900000000000000003"
                      type:
                        type: integer
                        example: 1
                      label:
                        type: string
                        example: new link
                      planId:
                        type: string
                        example: "700000000000000010"
                      accountId:
                        type: string
                        example: "800000000000000001"
                      price:
                        type: integer
                        example: 5000
                      paymentMethodRequired:
                        type: integer
                        example: 0
                      duration:
                        type: integer
                        example: 7
                      maxUses:
                        type: integer
                        example: 100
                      newSubscribersOnly:
                        type: integer
                        example: 1
                      startsAt:
                        type: integer
                        example: 0
                      endsAt:
                        type: integer
                        example: 0
                      status:
                        type: integer
                        example: 2
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055787
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Subscription Discounts
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Enable Subscription Discount (/api-reference/fansly/subscription-discounts/enable-subscription-discount)

Re-enable a previously disabled subscription discount.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/{fanslyAccount}/subscription-discounts/{discount_id}/enable
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/subscription-discounts/{discount_id}/enable:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: discount_id
        description: The Fansly subscription discount (gift code) ID.
        example: "927958667997761536"
        required: true
        schema:
          type: string
    post:
      summary: Enable Subscription Discount
      operationId: enableSubscriptionDiscount
      description: Re-enable a previously disabled subscription discount.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: "900000000000000003"
                    type: 1
                    label: new link
                    planId: "700000000000000010"
                    accountId: "800000000000000001"
                    price: 5000
                    paymentMethodRequired: 0
                    duration: 7
                    maxUses: 100
                    newSubscribersOnly: 1
                    startsAt: 0
                    endsAt: 0
                    status: 1
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055786
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: "900000000000000003"
                      type:
                        type: integer
                        example: 1
                      label:
                        type: string
                        example: new link
                      planId:
                        type: string
                        example: "700000000000000010"
                      accountId:
                        type: string
                        example: "800000000000000001"
                      price:
                        type: integer
                        example: 5000
                      paymentMethodRequired:
                        type: integer
                        example: 0
                      duration:
                        type: integer
                        example: 7
                      maxUses:
                        type: integer
                        example: 100
                      newSubscribersOnly:
                        type: integer
                        example: 1
                      startsAt:
                        type: integer
                        example: 0
                      endsAt:
                        type: integer
                        example: 0
                      status:
                        type: integer
                        example: 1
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055786
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Subscription Discounts
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Subscription Discounts (/api-reference/fansly/subscription-discounts/list-subscription-discounts)

Get all subscription discounts (gift links) configured on the Fansly Account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/subscription-discounts
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/subscription-discounts:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Subscription Discounts
      operationId: listSubscriptionDiscounts
      description: Get all subscription discounts (gift links) configured on the
        Fansly Account.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - id: "900000000000000001"
                      type: 1
                      label: Launch Week – 50% OFF
                      accountId: "800000000000000001"
                      code: OTAwMDAwMDAwMDAwMDAwMDAxOjE6MTowMWJlZWYxNDYy
                      planId: "700000000000000010"
                      status: 1
                      price: 2500
                      original_price: 5000
                      paymentMethodRequired: 0
                      duration: 7
                      maxUses: 100
                      uses: 4
                      newSubscribersOnly: 1
                      version: 2
                      createdAt: 1762620824000
                      startsAt: 1762620788000
                      endsAt: 1763225580000
                    - id: "900000000000000002"
                      type: 1
                      label: ""
                      accountId: "800000000000000001"
                      code: OTAwMDAwMDAwMDAwMDAwMDAyOjE6MTpkN2ZlMTAwYzk1
                      planId: "700000000000000011"
                      status: 2
                      price: 5000
                      original_price: 5000
                      paymentMethodRequired: 0
                      duration: 7
                      maxUses: 100
                      uses: 0
                      newSubscribersOnly: 1
                      version: 1
                      createdAt: 1762402358000
                      startsAt: null
                      endsAt: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055790
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: array
                    example:
                      - id: "900000000000000001"
                        type: 1
                        label: Launch Week – 50% OFF
                        accountId: "800000000000000001"
                        code: OTAwMDAwMDAwMDAwMDAwMDAxOjE6MTowMWJlZWYxNDYy
                        planId: "700000000000000010"
                        status: 1
                        price: 2500
                        original_price: 5000
                        paymentMethodRequired: 0
                        duration: 7
                        maxUses: 100
                        uses: 4
                        newSubscribersOnly: 1
                        version: 2
                        createdAt: 1762620824000
                        startsAt: 1762620788000
                        endsAt: 1763225580000
                      - id: "900000000000000002"
                        type: 1
                        label: ""
                        accountId: "800000000000000001"
                        code: OTAwMDAwMDAwMDAwMDAwMDAyOjE6MTpkN2ZlMTAwYzk1
                        planId: "700000000000000011"
                        status: 2
                        price: 5000
                        original_price: 5000
                        paymentMethodRequired: 0
                        duration: 7
                        maxUses: 100
                        uses: 0
                        newSubscribersOnly: 1
                        version: 1
                        createdAt: 1762402358000
                        startsAt: null
                        endsAt: null
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: "900000000000000001"
                        type:
                          type: integer
                          example: 1
                        label:
                          type: string
                          example: Launch Week – 50% OFF
                        accountId:
                          type: string
                          example: "800000000000000001"
                        code:
                          type: string
                          example: OTAwMDAwMDAwMDAwMDAwMDAxOjE6MTowMWJlZWYxNDYy
                        planId:
                          type: string
                          example: "700000000000000010"
                        status:
                          type: integer
                          example: 1
                        price:
                          type: integer
                          example: 2500
                        original_price:
                          type: integer
                          example: 5000
                        paymentMethodRequired:
                          type: integer
                          example: 0
                        duration:
                          type: integer
                          example: 7
                        maxUses:
                          type: integer
                          example: 100
                        uses:
                          type: integer
                          example: 4
                        newSubscribersOnly:
                          type: integer
                          example: 1
                        version:
                          type: integer
                          example: 2
                        createdAt:
                          type: integer
                          example: 1762620824000
                        startsAt:
                          type: integer
                          example: 1762620788000
                        endsAt:
                          type: integer
                          example: 1763225580000
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055790
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Subscription Discounts
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Update Subscription Discount (/api-reference/fansly/subscription-discounts/update-subscription-discount)

Update an existing subscription discount (gift link). Same body and validation as **Create Subscription Discount**.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml put /api/fansly/{fanslyAccount}/subscription-discounts/{discount_id}
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/subscription-discounts/{discount_id}:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: discount_id
        description: The Fansly subscription discount (gift code) ID.
        example: "927958667997761536"
        required: true
        schema:
          type: string
    put:
      summary: Update Subscription Discount
      operationId: updateSubscriptionDiscount
      description: Update an existing subscription discount (gift link). Same body and
        validation as **Create Subscription Discount**.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: "900000000000000003"
                    type: 1
                    label: new link
                    planId: "700000000000000010"
                    accountId: "800000000000000001"
                    price: 5000
                    paymentMethodRequired: 0
                    duration: 7
                    maxUses: 100
                    newSubscribersOnly: 1
                    startsAt: 0
                    endsAt: 0
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055788
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: "900000000000000003"
                      type:
                        type: integer
                        example: 1
                      label:
                        type: string
                        example: new link
                      planId:
                        type: string
                        example: "700000000000000010"
                      accountId:
                        type: string
                        example: "800000000000000001"
                      price:
                        type: integer
                        example: 5000
                      paymentMethodRequired:
                        type: integer
                        example: 0
                      duration:
                        type: integer
                        example: 7
                      maxUses:
                        type: integer
                        example: 100
                      newSubscribersOnly:
                        type: integer
                        example: 1
                      startsAt:
                        type: integer
                        example: 0
                      endsAt:
                        type: integer
                        example: 0
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055788
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Subscription Discounts
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                plan_id:
                  type: string
                  description: The subscription plan ID this discount renews for.
                  example: "843584256495083520"
                price:
                  type: integer
                  description: Discounted price in cents (e.g. 5000 = $5.00).
                  example: 5000
                duration:
                  type: integer
                  description: Duration in days until the subscriber rebills at the full
                    subscription price.
                  example: 7
                label:
                  type: string
                  description: Optional internal label for the discount.
                  example: new link
                max_uses:
                  type: integer
                  description: Maximum number of times the discount can be claimed. Default = 100.
                  example: 100
                new_subscribers_only:
                  type: integer
                  description: Set to 1 to exclude users who have already claimed a discount for
                    this plan, 0 to allow everyone. Default = 1.
                  example: 1
                starts_at:
                  type: integer
                  description: Optional start time as a UTC epoch in milliseconds. 0 (default)
                    means active immediately.
                  example: 1782737160000
                ends_at:
                  type: integer
                  description: Optional end time as a UTC epoch in milliseconds. 0 (default) means
                    no expiry.
                  example: 1782823560000
              required:
                - plan_id
                - price
                - duration
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Create Tracking Link (/api-reference/fansly/tracking-links/create-tracking-link)

Create a new tracking link.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/{fanslyAccount}/tracking-links
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/tracking-links:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Create Tracking Link
      operationId: createTrackingLink
      description: Create a new tracking link.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: "100000000000000003"
                    accountId: "800000000000000001"
                    internalId: 1002
                    type: 1000
                    status: 1
                    label: Twitter bio
                    description: Traffic from my Twitter bio link.
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055797
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: "100000000000000003"
                      accountId:
                        type: string
                        example: "800000000000000001"
                      internalId:
                        type: integer
                        example: 1002
                      type:
                        type: integer
                        example: 1000
                      status:
                        type: integer
                        example: 1
                      label:
                        type: string
                        example: Twitter bio
                      description:
                        type: string
                        example: Traffic from my Twitter bio link.
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055797
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Tracking Links
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                label:
                  type: string
                  description: The label for the tracking link.
                  example: Twitter bio
                description:
                  type: string
                  description: Optional description for the tracking link.
                  example: Traffic from my Twitter bio link.
              required:
                - label
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Delete Tracking Link (/api-reference/fansly/tracking-links/delete-tracking-link)

Delete a tracking link.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml delete /api/fansly/{fanslyAccount}/tracking-links/{tracking_link_id}
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/tracking-links/{tracking_link_id}:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: tracking_link_id
        description: The Fansly tracking link ID.
        example: "845759434926862336"
        required: true
        schema:
          type: string
    delete:
      summary: Delete Tracking Link
      operationId: deleteTrackingLink
      description: Delete a tracking link.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055795
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: string
                    example: null
                    nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055795
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Tracking Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Tracking Link Revenue Stats (/api-reference/fansly/tracking-links/get-tracking-link-revenue-stats)

Get daily revenue (gross + net) for a tracking link over a date range.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/tracking-links/{tracking_link_id}/revenue-stats
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/tracking-links/{tracking_link_id}/revenue-stats:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: tracking_link_id
        description: The Fansly tracking link ID.
        example: "845759434926862336"
        required: true
        schema:
          type: string
    get:
      summary: Get Tracking Link Revenue Stats
      operationId: getTrackingLinkRevenueStats
      description: Get daily revenue (gross + net) for a tracking link over a date range.
      parameters:
        - in: query
          name: before
          description: End of the date range (ISO 8601). Defaults to now.
          example: 2026-06-03T23:59:59Z
          required: false
          schema:
            type: string
            description: End of the date range (ISO 8601). Defaults to now.
            example: 2026-06-03T23:59:59Z
        - in: query
          name: after
          description: Start of the date range (ISO 8601). Defaults to 30 days ago.
          example: 2026-05-03T00:00:00Z
          required: false
          schema:
            type: string
            description: Start of the date range (ISO 8601). Defaults to 30 days ago.
            example: 2026-05-03T00:00:00Z
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - trackingLinkId: "100000000000000001"
                      type: 2116
                      timestamp: 1780358400000
                      totalGross: 5000
                      totalNet: 4000
                      year: 2026
                      month: 5
                      date: 30
                    - trackingLinkId: "100000000000000001"
                      type: 2116
                      timestamp: 1780444800000
                      totalGross: 10000
                      totalNet: 8000
                      year: 2026
                      month: 5
                      date: 31
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055798
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: array
                    example:
                      - trackingLinkId: "100000000000000001"
                        type: 2116
                        timestamp: 1780358400000
                        totalGross: 5000
                        totalNet: 4000
                        year: 2026
                        month: 5
                        date: 30
                      - trackingLinkId: "100000000000000001"
                        type: 2116
                        timestamp: 1780444800000
                        totalGross: 10000
                        totalNet: 8000
                        year: 2026
                        month: 5
                        date: 31
                    items:
                      type: object
                      properties:
                        trackingLinkId:
                          type: string
                          example: "100000000000000001"
                        type:
                          type: integer
                          example: 2116
                        timestamp:
                          type: integer
                          example: 1780358400000
                        totalGross:
                          type: integer
                          example: 5000
                        totalNet:
                          type: integer
                          example: 4000
                        year:
                          type: integer
                          example: 2026
                        month:
                          type: integer
                          example: 5
                        date:
                          type: integer
                          example: 30
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055798
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Tracking Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Tracking Link Stats (/api-reference/fansly/tracking-links/get-tracking-link-stats)

Get daily engagement metrics (clicks, claims, follows, subscriptions) for a tracking link over a date range.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/tracking-links/{tracking_link_id}/stats
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/tracking-links/{tracking_link_id}/stats:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: tracking_link_id
        description: The Fansly tracking link ID.
        example: "845759434926862336"
        required: true
        schema:
          type: string
    get:
      summary: Get Tracking Link Stats
      operationId: getTrackingLinkStats
      description: Get daily engagement metrics (clicks, claims, follows,
        subscriptions) for a tracking link over a date range.
      parameters:
        - in: query
          name: before
          description: End of the date range (ISO 8601). Defaults to now.
          example: 2026-06-03T23:59:59Z
          required: false
          schema:
            type: string
            description: End of the date range (ISO 8601). Defaults to now.
            example: 2026-06-03T23:59:59Z
        - in: query
          name: after
          description: Start of the date range (ISO 8601). Defaults to 30 days ago.
          example: 2026-05-03T00:00:00Z
          required: false
          schema:
            type: string
            description: Start of the date range (ISO 8601). Defaults to 30 days ago.
            example: 2026-05-03T00:00:00Z
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - trackingLinkId: "100000000000000001"
                      timestamp: 1780358400000
                      clicks: 12
                      claims: 8
                      follows: 3
                      subscriptions: 1
                      year: 2026
                      month: 5
                      date: 30
                    - trackingLinkId: "100000000000000001"
                      timestamp: 1780444800000
                      clicks: 18
                      claims: 11
                      follows: 4
                      subscriptions: 2
                      year: 2026
                      month: 5
                      date: 31
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055799
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: array
                    example:
                      - trackingLinkId: "100000000000000001"
                        timestamp: 1780358400000
                        clicks: 12
                        claims: 8
                        follows: 3
                        subscriptions: 1
                        year: 2026
                        month: 5
                        date: 30
                      - trackingLinkId: "100000000000000001"
                        timestamp: 1780444800000
                        clicks: 18
                        claims: 11
                        follows: 4
                        subscriptions: 2
                        year: 2026
                        month: 5
                        date: 31
                    items:
                      type: object
                      properties:
                        trackingLinkId:
                          type: string
                          example: "100000000000000001"
                        timestamp:
                          type: integer
                          example: 1780358400000
                        clicks:
                          type: integer
                          example: 12
                        claims:
                          type: integer
                          example: 8
                        follows:
                          type: integer
                          example: 3
                        subscriptions:
                          type: integer
                          example: 1
                        year:
                          type: integer
                          example: 2026
                        month:
                          type: integer
                          example: 5
                        date:
                          type: integer
                          example: 30
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055799
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Tracking Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Tracking Links (/api-reference/fansly/tracking-links/list-tracking-links)

Get all tracking links for the Fansly Account, with aggregate counts for clicks, claims, follows, subscriptions, and revenue totals.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/tracking-links
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/tracking-links:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Tracking Links
      operationId: listTrackingLinks
      description: Get all tracking links for the Fansly Account, with aggregate
        counts for clicks, claims, follows, subscriptions, and revenue totals.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - id: "100000000000000001"
                      accountId: "800000000000000001"
                      internalId: "1"
                      type: 1
                      status: 1
                      label: Fansly FYP
                      description: Traffic from the Fansly FYP.
                      metadata: "{}"
                      createdAt: 1762976852000
                      clicks: 0
                      claims: 25062
                      follows: 6364
                      subscriptions: 204
                      totalNet: 0
                      totalGross: 54245542
                    - id: "100000000000000002"
                      accountId: "800000000000000001"
                      internalId: "1001"
                      type: 1000
                      status: 1
                      label: Twitter bio
                      description: Traffic from my Twitter bio link.
                      metadata: "{}"
                      createdAt: 1765458304000
                      clicks: 224
                      claims: 147
                      follows: 56
                      subscriptions: 4
                      totalNet: 0
                      totalGross: 84990
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055800
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: array
                    example:
                      - id: "100000000000000001"
                        accountId: "800000000000000001"
                        internalId: "1"
                        type: 1
                        status: 1
                        label: Fansly FYP
                        description: Traffic from the Fansly FYP.
                        metadata: "{}"
                        createdAt: 1762976852000
                        clicks: 0
                        claims: 25062
                        follows: 6364
                        subscriptions: 204
                        totalNet: 0
                        totalGross: 54245542
                      - id: "100000000000000002"
                        accountId: "800000000000000001"
                        internalId: "1001"
                        type: 1000
                        status: 1
                        label: Twitter bio
                        description: Traffic from my Twitter bio link.
                        metadata: "{}"
                        createdAt: 1765458304000
                        clicks: 224
                        claims: 147
                        follows: 56
                        subscriptions: 4
                        totalNet: 0
                        totalGross: 84990
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: "100000000000000001"
                        accountId:
                          type: string
                          example: "800000000000000001"
                        internalId:
                          type: string
                          example: "1"
                        type:
                          type: integer
                          example: 1
                        status:
                          type: integer
                          example: 1
                        label:
                          type: string
                          example: Fansly FYP
                        description:
                          type: string
                          example: Traffic from the Fansly FYP.
                        metadata:
                          type: string
                          example: "{}"
                        createdAt:
                          type: integer
                          example: 1762976852000
                        clicks:
                          type: integer
                          example: 0
                        claims:
                          type: integer
                          example: 25062
                        follows:
                          type: integer
                          example: 6364
                        subscriptions:
                          type: integer
                          example: 204
                        totalNet:
                          type: integer
                          example: 0
                        totalGross:
                          type: integer
                          example: 54245542
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055800
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Tracking Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Update Tracking Link (/api-reference/fansly/tracking-links/update-tracking-link)

Update an existing tracking link's label and description.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml put /api/fansly/{fanslyAccount}/tracking-links/{tracking_link_id}
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/tracking-links/{tracking_link_id}:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: tracking_link_id
        description: The Fansly tracking link ID.
        example: "845759434926862336"
        required: true
        schema:
          type: string
    put:
      summary: Update Tracking Link
      operationId: updateTrackingLink
      description: Update an existing tracking link's label and description.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: "100000000000000003"
                    accountId: "800000000000000001"
                    internalId: "1002"
                    type: 1000
                    status: 1
                    label: Twitter bio (updated)
                    description: Updated description.
                    metadata: "{}"
                    createdAt: 1780512430000
                    clicks: null
                    claims: null
                    follows: null
                    subscriptions: null
                    totalNet: null
                    totalGross: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055796
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: "100000000000000003"
                      accountId:
                        type: string
                        example: "800000000000000001"
                      internalId:
                        type: string
                        example: "1002"
                      type:
                        type: integer
                        example: 1000
                      status:
                        type: integer
                        example: 1
                      label:
                        type: string
                        example: Twitter bio (updated)
                      description:
                        type: string
                        example: Updated description.
                      metadata:
                        type: string
                        example: "{}"
                      createdAt:
                        type: integer
                        example: 1780512430000
                      clicks:
                        type: string
                        example: null
                        nullable: true
                      claims:
                        type: string
                        example: null
                        nullable: true
                      follows:
                        type: string
                        example: null
                        nullable: true
                      subscriptions:
                        type: string
                        example: null
                        nullable: true
                      totalNet:
                        type: string
                        example: null
                        nullable: true
                      totalGross:
                        type: string
                        example: null
                        nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055796
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Tracking Links
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                label:
                  type: string
                  description: The updated label for the tracking link.
                  example: Twitter bio (updated)
                description:
                  type: string
                  description: Optional description for the tracking link.
                  example: Updated description.
              required:
                - label
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Example scenarios (/integrations/make/example-scenarios)

import {ArrowLeftRightIcon, LinkIcon} from "lucide-react";

<Cards>
  <Card icon={<LinkIcon className="text-fd-primary"/>} href="/integrations/make/example-scenarios/tracking-links-airtable" title="Tracking Links + Airtable">
    Learn how to easily synchronize <span className="font-semibold text-fd-primary">Tracking Link Data</span> from your OnlyFans accounts to Airtable.
  </Card>

  <Card icon={<ArrowLeftRightIcon className="text-fd-primary"/>} href="/integrations/make/example-scenarios/transaction-data-airtable" title="Transaction Data + Airtable">
    Learn how to easily synchronize <span className="font-semibold text-fd-primary">Transaction Data</span> from your OnlyFans accounts to Airtable.
  </Card>
</Cards>

# [Airtable] Tracking links (/integrations/make/example-scenarios/tracking-links-airtable)

import { Step, Steps } from 'fumadocs-ui/components/steps';

For this example, we'll create a scenario that periodically retrieves the tracking link data from all of your connected OnlyFans accounts, and saves the data to Airtable.

<Steps>
  <Step>
    #### Create a base on Airtable

    Go to Airtable and create a base. You can name it "OnlyFans API", or anything else that will help you identify it later.
  </Step>

  <Step>
    #### Create a table within your base

    Within the base, create a table named "Tracking links". Give the table the following fields:

    * `ID` (primary) - Single line text
    * `Campaign code` - Single line text
    * `Campaign URL` - URL
    * `Clicks count` - Number
    * `Subscriber count` - Number
    * `Total revenue` - Currency

    Your table should now look like this:
        <img alt="" src={__img0} placeholder="blur" />
  </Step>

  <Step>
    #### Add our "List Accounts" module

    If you don't see this module, make sure to click on "Show more".
        <img alt="" src={__img1} placeholder="blur" />
  </Step>

  <Step>
    #### Add our "List Tracking Links" module

    After adding "List Tracking Links" module, you will be asked to provide an "Account ID".
    Simply click on the field, and drag the "ID" from the left card into the field, like in the below image. Make sure to click on "Save".
        <img alt="" src={__img2} placeholder="blur" />
  </Step>

  <Step>
    #### Add the Airtable "Create a Record" module

    If you don't see this module, make sure to click on "Show more".
  </Step>

  <Step>
    #### Connect your Airtable account, and select the correct Base and Table

        <img alt="" src={__img3} placeholder="blur" />
  </Step>

  <Step>
    #### Map the fields

    Now, let's map the OnlyFans API module fields to your Airtable's table fields. Make sure to click on "Save".
    If you've done it correctly, your scenario should look like this:
        <img alt="" src={__img4} placeholder="blur" />
  </Step>

  <Step>
    #### Finally, schedule and run the scenario!

    You can set a schedule time, and then run it manually with the "Run once" button to see if everything works correctly.

    If it does, you will see the tracking link data of all your accounts appear in your Airtable table, like so:
        <img alt="" src={__img5} placeholder="blur" />
  </Step>
</Steps>

<Callout title="That's it!">
  The tracking link data of all of your connected OnlyFans accounts will now automatically be updated in Airtable.

  Of course, you can further customize this scenario for a more advanced setup.
</Callout>

# [Airtable] Tracking links (/integrations/make/example-scenarios/transaction-data-airtable)

import { Step, Steps } from 'fumadocs-ui/components/steps';

For this example, we'll create a scenario that periodically retrieves the transaction data from all of your connected OnlyFans accounts, and saves the data to Airtable.

<Steps>
  <Step>
    #### Create a base on Airtable

    Go to Airtable and create a base. You can name it "OnlyFans API", or anything else that will help you identify it later.
  </Step>

  <Step>
    #### Create a table within your base

    Within the base, create a table named "Transaction data". Give the table the following fields:

    * `Transaction ID` (primary) - Single line text
    * `Account name` - Single line text
    * `Amount` - Currency
    * `Net amount` - Currency

    Your table should now look like this:
        <img alt="" src={__img0} placeholder="blur" />
  </Step>

  <Step>
    #### Add our "List Accounts" module

        <img alt="" src={__img1} placeholder="blur" />
  </Step>

  <Step>
    #### Add our "List Transactions" module

    You will be asked to provide an "Account ID".
    Simply click on the field, and drag the "ID" from the left card into the field. Afterwards, choose a start date like "-30 days".
        <img alt="" src={__img2} placeholder="blur" />

    Afterwards, make sure to click on "Save".
  </Step>

  <Step>
    #### Add the Airtable "Create a Record" module

    If you don't see this module, make sure to click on "Show more".
  </Step>

  <Step>
    #### Connect your Airtable account, and select the correct Base and Table

        <img alt="" src={__img3} placeholder="blur" />
  </Step>

  <Step>
    #### Map the fields

    Now, let's map the OnlyFans API module fields to your Airtable's table fields. Make sure to click on "Save".
    If you've done it correctly, your scenario should look like this:
        <img alt="" src={__img4} placeholder="blur" />
  </Step>

  <Step>
    #### Finally, schedule and run the scenario!

    You can set a schedule time, and then run it manually with the "Run once" button to see if everything works correctly.

    If it does, you will see the tracking link data of all your accounts appear in your Airtable table, like so:
        <img alt="" src={__img5} placeholder="blur" />
  </Step>
</Steps>

<Callout title="That's it!">
  The transaction data of all of your connected OnlyFans accounts will now automatically be updated in Airtable.

  Of course, you can further customize this scenario for a more advanced setup.
</Callout>

# Create Wall (/api-reference/fansly/walls/create-wall)

Create a new wall on the Fansly Account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/{fanslyAccount}/walls
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/walls:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Create Wall
      operationId: createWall
      description: Create a new wall on the Fansly Account.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: "200000000000000011"
                    accountId: "800000000000000001"
                    name: Behind the scenes
                    copyFrom: null
                    description: Exclusive BTS content
                    pos: null
                    private: 0
                    metadata: ""
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055789
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: "200000000000000011"
                      accountId:
                        type: string
                        example: "800000000000000001"
                      name:
                        type: string
                        example: Behind the scenes
                      copyFrom:
                        type: string
                        example: null
                        nullable: true
                      description:
                        type: string
                        example: Exclusive BTS content
                      pos:
                        type: string
                        example: null
                        nullable: true
                      private:
                        type: integer
                        example: 0
                      metadata:
                        type: string
                        example: ""
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055789
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Walls
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The name of the wall.
                  example: Behind the scenes
                description:
                  type: string
                  description: An optional wall description.
                  example: Exclusive BTS content
                setAsDefault:
                  type: boolean
                  description: Set the wall as your Main Feed. You can have only one Main Feed at
                    a time, and any post published there also appears in fans'
                    Home feeds. Switching your Main Feed does not affect FYP
                    promotion.
                  example: false
                private:
                  type: boolean
                  description: Set the wall to Private to keep it visible only to you; visitors to
                    your profile won't see it. This setting does not affect FYP
                    promotion.
                  example: false
                copyFrom:
                  type: string
                  description: A wall ID to copy posts from — automatically adds all posts on that
                    wall to the new wall. It may take a few minutes for
                    everything to appear.
                  example: "200000000000000010"
              required:
                - name
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Walls (/api-reference/fansly/walls/list-walls)

Get all walls configured on the Fansly Account. Use the returned wall IDs as `wallIds` when sending a post. The wall with `defaultWall: true` is the account's Main Feed.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/walls
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/walls:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Walls
      operationId: listWalls
      description: "Get all walls configured on the Fansly Account. Use the returned
        wall IDs as `wallIds` when sending a post. The wall with `defaultWall:
        true` is the account's Main Feed."
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - id: "200000000000000010"
                      accountId: "800000000000000001"
                      pos: 0
                      name: Posts
                      description: ""
                      private: 0
                      metadata: ""
                      defaultWall: true
                      mainWall: true
                    - id: "200000000000000011"
                      accountId: "800000000000000001"
                      pos: 1
                      name: Behind the scenes
                      description: Exclusive BTS content
                      private: 0
                      metadata: ""
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055789
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: array
                    example:
                      - id: "200000000000000010"
                        accountId: "800000000000000001"
                        pos: 0
                        name: Posts
                        description: ""
                        private: 0
                        metadata: ""
                        defaultWall: true
                        mainWall: true
                      - id: "200000000000000011"
                        accountId: "800000000000000001"
                        pos: 1
                        name: Behind the scenes
                        description: Exclusive BTS content
                        private: 0
                        metadata: ""
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: "200000000000000010"
                        accountId:
                          type: string
                          example: "800000000000000001"
                        pos:
                          type: integer
                          example: 0
                        name:
                          type: string
                          example: Posts
                        description:
                          type: string
                          example: ""
                        private:
                          type: integer
                          example: 0
                        metadata:
                          type: string
                          example: ""
                        defaultWall:
                          type: boolean
                          example: true
                        mainWall:
                          type: boolean
                          example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055789
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Walls
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Block User (/api-reference/fansly/users/block-user)

Block a Fansly user for the authenticated Fansly Account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/{fanslyAccount}/users/{account_id}/block
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/users/{account_id}/block:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: account_id
        description: The Fansly account ID to block.
        example: "800000000000000002"
        required: true
        schema:
          type: string
    post:
      summary: Block User
      operationId: blockUser
      description: Block a Fansly user for the authenticated Fansly Account.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    accountId: "800000000000000001"
                    ignoredId: "800000000000000002"
                    ignoreFlags: 2
                  _meta:
                    _credits:
                      used: 1
                      balance: 100000
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      accountId:
                        type: string
                        example: "800000000000000001"
                      ignoredId:
                        type: string
                        example: "800000000000000002"
                      ignoreFlags:
                        type: integer
                        example: 2
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 100000
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Users
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Create User Note (/api-reference/fansly/users/create-user-note)

Create a Fansly note for a user.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/{fanslyAccount}/users/{account_id}/notes
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/users/{account_id}/notes:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: account_id
        description: The Fansly account ID to create a note for.
        example: "800000000000000002"
        required: true
        schema:
          type: string
    post:
      summary: Create User Note
      operationId: createUserNote
      description: Create a Fansly note for a user.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    accountId: "800000000000000001"
                    contentType: 12000
                    contentId: "800000000000000002"
                    title: Example note title
                    note: |-
                      Example note body

                      newline
                    id: "200000000000000002"
                  _meta:
                    _credits:
                      used: 1
                      balance: 100000
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      accountId:
                        type: string
                        example: "800000000000000001"
                      contentType:
                        type: integer
                        example: 12000
                      contentId:
                        type: string
                        example: "800000000000000002"
                      title:
                        type: string
                        example: Example note title
                      note:
                        type: string
                        example: |-
                          Example note body

                          newline
                      id:
                        type: string
                        example: "200000000000000002"
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 100000
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  description: The note title.
                  example: Example note title
                note:
                  type: string
                  description: The note body.
                  example: |-
                    Example note body

                    newline
              required:
                - title
                - note
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Delete User Custom Name (/api-reference/fansly/users/delete-user-custom-name)

Delete an existing Fansly custom-name note for a user.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml delete /api/fansly/{fanslyAccount}/users/{account_id}/custom-name/{note_id}
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/users/{account_id}/custom-name/{note_id}:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: account_id
        description: The Fansly account ID whose custom name should be edited.
        example: "800000000000000002"
        required: true
        schema:
          type: string
      - in: path
        name: note_id
        description: The Fansly note ID returned when the custom name was created.
        example: "200000000000000002"
        required: true
        schema:
          type: string
    delete:
      summary: Delete User Custom Name
      operationId: deleteUserCustomName
      description: Delete an existing Fansly custom-name note for a user.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: "200000000000000002"
                    accountId: "800000000000000001"
                  _meta:
                    _credits:
                      used: 1
                      balance: 100000
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: "200000000000000002"
                      accountId:
                        type: string
                        example: "800000000000000001"
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 100000
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                custom_name:
                  type: string
                  description: The current custom name value being deleted.
                  example: Example Name
              required:
                - custom_name
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Delete User Note (/api-reference/fansly/users/delete-user-note)

Delete an existing Fansly note for a user.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml delete /api/fansly/{fanslyAccount}/users/{account_id}/notes/{note_id}
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/users/{account_id}/notes/{note_id}:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: account_id
        description: The Fansly account ID whose note should be edited.
        example: "800000000000000002"
        required: true
        schema:
          type: string
      - in: path
        name: note_id
        description: The Fansly note ID.
        example: "200000000000000002"
        required: true
        schema:
          type: string
    delete:
      summary: Delete User Note
      operationId: deleteUserNote
      description: Delete an existing Fansly note for a user.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: "200000000000000002"
                    accountId: "800000000000000001"
                  _meta:
                    _credits:
                      used: 1
                      balance: 100000
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: "200000000000000002"
                      accountId:
                        type: string
                        example: "800000000000000001"
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 100000
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  description: The current note title being deleted.
                  example: Example note title
                note:
                  type: string
                  description: The current note body being deleted.
                  example: |-
                    Example note body

                    newline
              required:
                - title
                - note
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Edit User Custom Name (/api-reference/fansly/users/edit-user-custom-name)

Edit an existing Fansly custom-name note for a user.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml put /api/fansly/{fanslyAccount}/users/{account_id}/custom-name/{note_id}
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/users/{account_id}/custom-name/{note_id}:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: account_id
        description: The Fansly account ID whose custom name should be edited.
        example: "800000000000000002"
        required: true
        schema:
          type: string
      - in: path
        name: note_id
        description: The Fansly note ID returned when the custom name was created.
        example: "200000000000000002"
        required: true
        schema:
          type: string
    put:
      summary: Edit User Custom Name
      operationId: editUserCustomName
      description: Edit an existing Fansly custom-name note for a user.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: "200000000000000002"
                    accountId: "800000000000000001"
                    title: Custom Username
                    note: Updated Example Name
                  _meta:
                    _credits:
                      used: 1
                      balance: 100000
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: "200000000000000002"
                      accountId:
                        type: string
                        example: "800000000000000001"
                      title:
                        type: string
                        example: Custom Username
                      note:
                        type: string
                        example: Updated Example Name
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 100000
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Users
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                custom_name:
                  type: string
                  description: The updated custom name to store for the user.
                  example: Updated Example Name
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Edit User Note (/api-reference/fansly/users/edit-user-note)

Edit an existing Fansly note for a user.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml put /api/fansly/{fanslyAccount}/users/{account_id}/notes/{note_id}
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/users/{account_id}/notes/{note_id}:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: account_id
        description: The Fansly account ID whose note should be edited.
        example: "800000000000000002"
        required: true
        schema:
          type: string
      - in: path
        name: note_id
        description: The Fansly note ID.
        example: "200000000000000002"
        required: true
        schema:
          type: string
    put:
      summary: Edit User Note
      operationId: editUserNote
      description: Edit an existing Fansly note for a user.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: "200000000000000002"
                    accountId: "800000000000000001"
                    title: Updated example note title
                    note: |-
                      Updated example note body

                      newline
                  _meta:
                    _credits:
                      used: 1
                      balance: 100000
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: "200000000000000002"
                      accountId:
                        type: string
                        example: "800000000000000001"
                      title:
                        type: string
                        example: Updated example note title
                      note:
                        type: string
                        example: |-
                          Updated example note body

                          newline
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 100000
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  description: The updated note title.
                  example: Updated example note title
                note:
                  type: string
                  description: The updated note body.
                  example: |-
                    Updated example note body

                    newline
              required:
                - title
                - note
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Follow User (/api-reference/fansly/users/follow-user)

Follow a Fansly user from the authenticated Fansly Account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/{fanslyAccount}/users/{account_id}/follow
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/users/{account_id}/follow:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: account_id
        description: The Fansly account ID to follow.
        example: "800000000000000002"
        required: true
        schema:
          type: string
    post:
      summary: Follow User
      operationId: followUser
      description: Follow a Fansly user from the authenticated Fansly Account.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    followerId: "800000000000000001"
                    accountId: "800000000000000002"
                    id: "200000000000000003"
                    followerSortOrder: 1
                    accountSortOrder: 1
                  _meta:
                    _credits:
                      used: 1
                      balance: 100000
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      followerId:
                        type: string
                        example: "800000000000000001"
                      accountId:
                        type: string
                        example: "800000000000000002"
                      id:
                        type: string
                        example: "200000000000000003"
                      followerSortOrder:
                        type: integer
                        example: 1
                      accountSortOrder:
                        type: integer
                        example: 1
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 100000
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Users
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get User Details (/api-reference/fansly/users/get-user-details)

Get Fansly profile details for one or more users. Look them up by username in the URL path, or by Fansly account id via the `ids` query parameter. Either way you can pass a single value or a comma-separated list to fetch multiple profiles in a single call — bulk requests still only cost one API credit.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml get /api/fansly/{fanslyAccount}/users/{usernames}
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/users/{usernames}:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: usernames
        description: Optional parameter. A Fansly username, or a comma-separated list of
          usernames. Optional when the `ids` query parameter is supplied
          instead.
        required: true
        schema:
          type: string
        examples:
          omitted:
            summary: When the value is omitted
            value: ""
          present:
            summary: When the value is present
            value: exampleuser
    get:
      summary: Get User Details
      operationId: getUserDetails
      description: Get Fansly profile details for one or more users. Look them up by
        username in the URL path, or by Fansly account id via the `ids` query
        parameter. Either way you can pass a single value or a comma-separated
        list to fetch multiple profiles in a single call — bulk requests still
        only cost one API credit.
      parameters:
        - in: query
          name: ids
          description: A Fansly account id, or a comma-separated list of ids, to look up
            instead of usernames. Takes precedence over the URL path when
            provided.
          example: 285552020591489024,833499506455629824
          required: false
          schema:
            type: string
            description: A Fansly account id, or a comma-separated list of ids, to look up
              instead of usernames. Takes precedence over the URL path when
              provided.
            example: 285552020591489024,833499506455629824
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - id: "100000000000000001"
                      username: exampleuser
                      displayName: null
                      flags: 18
                      version: 3
                      followCount: 1000
                      subscriberCount: 0
                      permissions:
                        accountPermissionFlags:
                          flags: 2
                      timelineStats:
                        accountId: "100000000000000001"
                        imageCount: 200
                        videoCount: 100
                        bundleCount: 10
                        bundleImageCount: 50
                        bundleVideoCount: 0
                        fetchedAt: 1700000000000
                      mediaStoryState:
                        accountId: "100000000000000001"
                        status: 2
                        storyCount: 0
                        version: 1
                        createdAt: 1700000000000
                        updatedAt: 1700000000000
                        hasActiveStories: false
                      statusId: 1
                      lastSeenAt: 1700000000000
                      profileAccessFlags: 0
                      profileFlags: 0
                      about: About text
                      location: ""
                      profileSocials: []
                      profileBadges: []
                      following: true
                      accountMediaLikes: 1000
                      hasMainWall: true
                      walls:
                        - id: "200000000000000001"
                          accountId: "100000000000000001"
                          pos: 0
                          name: Posts
                          description: ""
                          private: 0
                          metadata: ""
                          defaultWall: true
                          mainWall: true
                      avatar:
                        id: "300000000000000001"
                        type: 1
                        status: 1
                        accountId: "100000000000000001"
                        mimetype: image/jpeg
                        flags: 0
                        location: /100000000000000001/300000000000000001.jpeg
                        width: 1080
                        height: 1440
                        metadata: '{"resolutionMode":2}'
                        updatedAt: 1700000000
                        createdAt: 1700000000
                        variants:
                          - id: "300000000000000002"
                            type: 1
                            status: 1
                            mimetype: image/jpeg
                            flags: 0
                            location: /100000000000000001/300000000000000002.jpeg
                            width: 720
                            height: 960
                            metadata: '{"resolutionMode":2}'
                            updatedAt: 1700000000
                            locations:
                              - locationId: "1"
                                location: https://cdn3.fansly.com/100000000000000001/300000000000000002.jpeg
                        variantHash: {}
                        locations:
                          - locationId: "1"
                            location: https://cdn3.fansly.com/100000000000000001/300000000000000001.jpeg
                      banner:
                        id: "400000000000000001"
                        type: 1
                        status: 1
                        accountId: "100000000000000001"
                        mimetype: image/jpeg
                        flags: 0
                        location: /100000000000000001/400000000000000001.jpeg
                        width: 1920
                        height: 1080
                        metadata: '{"resolutionMode":1}'
                        updatedAt: 1700000000
                        createdAt: 1700000000
                        variants: []
                        variantHash: {}
                        locations:
                          - locationId: "1"
                            location: https://cdn3.fansly.com/100000000000000001/400000000000000001.jpeg
                      streaming:
                        accountId: "100000000000000001"
                        channel: null
                        enabled: true
                      postLikes: 100
                      subscriptionTiers:
                        - id: "500000000000000001"
                          accountId: "100000000000000001"
                          name: Subscription
                          color: "#444444"
                          pos: 0
                          price: 5000
                          maxSubscribers: 0
                          subscriptionBenefits:
                            - Benefit one
                            - Benefit two
                          includedTierIds: []
                          plans:
                            - id: "500000000000000002"
                              status: 1
                              billingCycle: 30
                              price: 10000
                              useAmounts: 0
                              promos: []
                              uses: 0
                      profileAccess: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055812
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: array
                    example:
                      - id: "100000000000000001"
                        username: exampleuser
                        displayName: null
                        flags: 18
                        version: 3
                        followCount: 1000
                        subscriberCount: 0
                        permissions:
                          accountPermissionFlags:
                            flags: 2
                        timelineStats:
                          accountId: "100000000000000001"
                          imageCount: 200
                          videoCount: 100
                          bundleCount: 10
                          bundleImageCount: 50
                          bundleVideoCount: 0
                          fetchedAt: 1700000000000
                        mediaStoryState:
                          accountId: "100000000000000001"
                          status: 2
                          storyCount: 0
                          version: 1
                          createdAt: 1700000000000
                          updatedAt: 1700000000000
                          hasActiveStories: false
                        statusId: 1
                        lastSeenAt: 1700000000000
                        profileAccessFlags: 0
                        profileFlags: 0
                        about: About text
                        location: ""
                        profileSocials: []
                        profileBadges: []
                        following: true
                        accountMediaLikes: 1000
                        hasMainWall: true
                        walls:
                          - id: "200000000000000001"
                            accountId: "100000000000000001"
                            pos: 0
                            name: Posts
                            description: ""
                            private: 0
                            metadata: ""
                            defaultWall: true
                            mainWall: true
                        avatar:
                          id: "300000000000000001"
                          type: 1
                          status: 1
                          accountId: "100000000000000001"
                          mimetype: image/jpeg
                          flags: 0
                          location: /100000000000000001/300000000000000001.jpeg
                          width: 1080
                          height: 1440
                          metadata: '{"resolutionMode":2}'
                          updatedAt: 1700000000
                          createdAt: 1700000000
                          variants:
                            - id: "300000000000000002"
                              type: 1
                              status: 1
                              mimetype: image/jpeg
                              flags: 0
                              location: /100000000000000001/300000000000000002.jpeg
                              width: 720
                              height: 960
                              metadata: '{"resolutionMode":2}'
                              updatedAt: 1700000000
                              locations:
                                - locationId: "1"
                                  location: https://cdn3.fansly.com/100000000000000001/300000000000000002.jpeg
                          variantHash: []
                          locations:
                            - locationId: "1"
                              location: https://cdn3.fansly.com/100000000000000001/300000000000000001.jpeg
                        banner:
                          id: "400000000000000001"
                          type: 1
                          status: 1
                          accountId: "100000000000000001"
                          mimetype: image/jpeg
                          flags: 0
                          location: /100000000000000001/400000000000000001.jpeg
                          width: 1920
                          height: 1080
                          metadata: '{"resolutionMode":1}'
                          updatedAt: 1700000000
                          createdAt: 1700000000
                          variants: []
                          variantHash: []
                          locations:
                            - locationId: "1"
                              location: https://cdn3.fansly.com/100000000000000001/400000000000000001.jpeg
                        streaming:
                          accountId: "100000000000000001"
                          channel: null
                          enabled: true
                        postLikes: 100
                        subscriptionTiers:
                          - id: "500000000000000001"
                            accountId: "100000000000000001"
                            name: Subscription
                            color: "#444444"
                            pos: 0
                            price: 5000
                            maxSubscribers: 0
                            subscriptionBenefits:
                              - Benefit one
                              - Benefit two
                            includedTierIds: []
                            plans:
                              - id: "500000000000000002"
                                status: 1
                                billingCycle: 30
                                price: 10000
                                useAmounts: 0
                                promos: []
                                uses: 0
                        profileAccess: true
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: "100000000000000001"
                        username:
                          type: string
                          example: exampleuser
                        displayName:
                          type: string
                          example: null
                          nullable: true
                        flags:
                          type: integer
                          example: 18
                        version:
                          type: integer
                          example: 3
                        followCount:
                          type: integer
                          example: 1000
                        subscriberCount:
                          type: integer
                          example: 0
                        permissions:
                          type: object
                          properties:
                            accountPermissionFlags:
                              type: object
                              properties:
                                flags:
                                  type: integer
                                  example: 2
                        timelineStats:
                          type: object
                          properties:
                            accountId:
                              type: string
                              example: "100000000000000001"
                            imageCount:
                              type: integer
                              example: 200
                            videoCount:
                              type: integer
                              example: 100
                            bundleCount:
                              type: integer
                              example: 10
                            bundleImageCount:
                              type: integer
                              example: 50
                            bundleVideoCount:
                              type: integer
                              example: 0
                            fetchedAt:
                              type: integer
                              example: 1700000000000
                        mediaStoryState:
                          type: object
                          properties:
                            accountId:
                              type: string
                              example: "100000000000000001"
                            status:
                              type: integer
                              example: 2
                            storyCount:
                              type: integer
                              example: 0
                            version:
                              type: integer
                              example: 1
                            createdAt:
                              type: integer
                              example: 1700000000000
                            updatedAt:
                              type: integer
                              example: 1700000000000
                            hasActiveStories:
                              type: boolean
                              example: false
                        statusId:
                          type: integer
                          example: 1
                        lastSeenAt:
                          type: integer
                          example: 1700000000000
                        profileAccessFlags:
                          type: integer
                          example: 0
                        profileFlags:
                          type: integer
                          example: 0
                        about:
                          type: string
                          example: About text
                        location:
                          type: string
                          example: ""
                        profileSocials:
                          type: array
                          example: []
                        profileBadges:
                          type: array
                          example: []
                        following:
                          type: boolean
                          example: true
                        accountMediaLikes:
                          type: integer
                          example: 1000
                        hasMainWall:
                          type: boolean
                          example: true
                        walls:
                          type: array
                          example:
                            - id: "200000000000000001"
                              accountId: "100000000000000001"
                              pos: 0
                              name: Posts
                              description: ""
                              private: 0
                              metadata: ""
                              defaultWall: true
                              mainWall: true
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: "200000000000000001"
                              accountId:
                                type: string
                                example: "100000000000000001"
                              pos:
                                type: integer
                                example: 0
                              name:
                                type: string
                                example: Posts
                              description:
                                type: string
                                example: ""
                              private:
                                type: integer
                                example: 0
                              metadata:
                                type: string
                                example: ""
                              defaultWall:
                                type: boolean
                                example: true
                              mainWall:
                                type: boolean
                                example: true
                        avatar:
                          type: object
                          properties:
                            id:
                              type: string
                              example: "300000000000000001"
                            type:
                              type: integer
                              example: 1
                            status:
                              type: integer
                              example: 1
                            accountId:
                              type: string
                              example: "100000000000000001"
                            mimetype:
                              type: string
                              example: image/jpeg
                            flags:
                              type: integer
                              example: 0
                            location:
                              type: string
                              example: /100000000000000001/300000000000000001.jpeg
                            width:
                              type: integer
                              example: 1080
                            height:
                              type: integer
                              example: 1440
                            metadata:
                              type: string
                              example: '{"resolutionMode":2}'
                            updatedAt:
                              type: integer
                              example: 1700000000
                            createdAt:
                              type: integer
                              example: 1700000000
                            variants:
                              type: array
                              example:
                                - id: "300000000000000002"
                                  type: 1
                                  status: 1
                                  mimetype: image/jpeg
                                  flags: 0
                                  location: /100000000000000001/300000000000000002.jpeg
                                  width: 720
                                  height: 960
                                  metadata: '{"resolutionMode":2}'
                                  updatedAt: 1700000000
                                  locations:
                                    - locationId: "1"
                                      location: https://cdn3.fansly.com/100000000000000001/300000000000000002.jpeg
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: "300000000000000002"
                                  type:
                                    type: integer
                                    example: 1
                                  status:
                                    type: integer
                                    example: 1
                                  mimetype:
                                    type: string
                                    example: image/jpeg
                                  flags:
                                    type: integer
                                    example: 0
                                  location:
                                    type: string
                                    example: /100000000000000001/300000000000000002.jpeg
                                  width:
                                    type: integer
                                    example: 720
                                  height:
                                    type: integer
                                    example: 960
                                  metadata:
                                    type: string
                                    example: '{"resolutionMode":2}'
                                  updatedAt:
                                    type: integer
                                    example: 1700000000
                                  locations:
                                    type: array
                                    example:
                                      - locationId: "1"
                                        location: https://cdn3.fansly.com/100000000000000001/300000000000000002.jpeg
                                    items:
                                      type: object
                                      properties:
                                        locationId:
                                          type: string
                                          example: "1"
                                        location:
                                          type: string
                                          example: https://cdn3.fansly.com/100000000000000001/300000000000000002.jpeg
                            variantHash:
                              type: object
                              properties: {}
                            locations:
                              type: array
                              example:
                                - locationId: "1"
                                  location: https://cdn3.fansly.com/100000000000000001/300000000000000001.jpeg
                              items:
                                type: object
                                properties:
                                  locationId:
                                    type: string
                                    example: "1"
                                  location:
                                    type: string
                                    example: https://cdn3.fansly.com/100000000000000001/300000000000000001.jpeg
                        banner:
                          type: object
                          properties:
                            id:
                              type: string
                              example: "400000000000000001"
                            type:
                              type: integer
                              example: 1
                            status:
                              type: integer
                              example: 1
                            accountId:
                              type: string
                              example: "100000000000000001"
                            mimetype:
                              type: string
                              example: image/jpeg
                            flags:
                              type: integer
                              example: 0
                            location:
                              type: string
                              example: /100000000000000001/400000000000000001.jpeg
                            width:
                              type: integer
                              example: 1920
                            height:
                              type: integer
                              example: 1080
                            metadata:
                              type: string
                              example: '{"resolutionMode":1}'
                            updatedAt:
                              type: integer
                              example: 1700000000
                            createdAt:
                              type: integer
                              example: 1700000000
                            variants:
                              type: array
                              example: []
                            variantHash:
                              type: object
                              properties: {}
                            locations:
                              type: array
                              example:
                                - locationId: "1"
                                  location: https://cdn3.fansly.com/100000000000000001/400000000000000001.jpeg
                              items:
                                type: object
                                properties:
                                  locationId:
                                    type: string
                                    example: "1"
                                  location:
                                    type: string
                                    example: https://cdn3.fansly.com/100000000000000001/400000000000000001.jpeg
                        streaming:
                          type: object
                          properties:
                            accountId:
                              type: string
                              example: "100000000000000001"
                            channel:
                              type: string
                              example: null
                              nullable: true
                            enabled:
                              type: boolean
                              example: true
                        postLikes:
                          type: integer
                          example: 100
                        subscriptionTiers:
                          type: array
                          example:
                            - id: "500000000000000001"
                              accountId: "100000000000000001"
                              name: Subscription
                              color: "#444444"
                              pos: 0
                              price: 5000
                              maxSubscribers: 0
                              subscriptionBenefits:
                                - Benefit one
                                - Benefit two
                              includedTierIds: []
                              plans:
                                - id: "500000000000000002"
                                  status: 1
                                  billingCycle: 30
                                  price: 10000
                                  useAmounts: 0
                                  promos: []
                                  uses: 0
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: "500000000000000001"
                              accountId:
                                type: string
                                example: "100000000000000001"
                              name:
                                type: string
                                example: Subscription
                              color:
                                type: string
                                example: "#444444"
                              pos:
                                type: integer
                                example: 0
                              price:
                                type: integer
                                example: 5000
                              maxSubscribers:
                                type: integer
                                example: 0
                              subscriptionBenefits:
                                type: array
                                example:
                                  - Benefit one
                                  - Benefit two
                                items:
                                  type: string
                              includedTierIds:
                                type: array
                                example: []
                              plans:
                                type: array
                                example:
                                  - id: "500000000000000002"
                                    status: 1
                                    billingCycle: 30
                                    price: 10000
                                    useAmounts: 0
                                    promos: []
                                    uses: 0
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      example: "500000000000000002"
                                    status:
                                      type: integer
                                      example: 1
                                    billingCycle:
                                      type: integer
                                      example: 30
                                    price:
                                      type: integer
                                      example: 10000
                                    useAmounts:
                                      type: integer
                                      example: 0
                                    promos:
                                      type: array
                                      example: []
                                    uses:
                                      type: integer
                                      example: 0
                        profileAccess:
                          type: boolean
                          example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055812
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Users
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Mute User (/api-reference/fansly/users/mute-user)

Mute a Fansly user for the authenticated Fansly Account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/{fanslyAccount}/users/{account_id}/mute
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/users/{account_id}/mute:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: account_id
        description: The Fansly account ID to mute.
        example: "800000000000000002"
        required: true
        schema:
          type: string
    post:
      summary: Mute User
      operationId: muteUser
      description: Mute a Fansly user for the authenticated Fansly Account.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    accountId: "800000000000000001"
                    ignoredId: "800000000000000002"
                    ignoreFlags: 1
                  _meta:
                    _credits:
                      used: 1
                      balance: 100000
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      accountId:
                        type: string
                        example: "800000000000000001"
                      ignoredId:
                        type: string
                        example: "800000000000000002"
                      ignoreFlags:
                        type: integer
                        example: 1
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 100000
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Users
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Set User Custom Name (/api-reference/fansly/users/set-user-custom-name)

Create a Fansly custom-name note for a user.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml post /api/fansly/{fanslyAccount}/users/{account_id}/custom-name
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/users/{account_id}/custom-name:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: account_id
        description: The Fansly account ID whose custom name should be set.
        example: "800000000000000002"
        required: true
        schema:
          type: string
    post:
      summary: Set User Custom Name
      operationId: setUserCustomName
      description: Create a Fansly custom-name note for a user.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    accountId: "800000000000000001"
                    contentType: 12002
                    contentId: "800000000000000002"
                    title: Custom Username
                    note: Example Name
                    id: "200000000000000002"
                  _meta:
                    _credits:
                      used: 1
                      balance: 100000
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      accountId:
                        type: string
                        example: "800000000000000001"
                      contentType:
                        type: integer
                        example: 12002
                      contentId:
                        type: string
                        example: "800000000000000002"
                      title:
                        type: string
                        example: Custom Username
                      note:
                        type: string
                        example: Example Name
                      id:
                        type: string
                        example: "200000000000000002"
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 100000
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Users
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                custom_name:
                  type: string
                  description: The custom name to store for the user.
                  example: Example Name
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Unblock User (/api-reference/fansly/users/unblock-user)

Unblock a Fansly user for the authenticated Fansly Account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml delete /api/fansly/{fanslyAccount}/users/{account_id}/block
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/users/{account_id}/block:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: account_id
        description: The Fansly account ID to block.
        example: "800000000000000002"
        required: true
        schema:
          type: string
    delete:
      summary: Unblock User
      operationId: unblockUser
      description: Unblock a Fansly user for the authenticated Fansly Account.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    accountId: "800000000000000001"
                    ignoredId: "800000000000000002"
                    ignoreFlags: 0
                  _meta:
                    _credits:
                      used: 1
                      balance: 100000
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      accountId:
                        type: string
                        example: "800000000000000001"
                      ignoredId:
                        type: string
                        example: "800000000000000002"
                      ignoreFlags:
                        type: integer
                        example: 0
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 100000
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Users
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Unfollow User (/api-reference/fansly/users/unfollow-user)

Unfollow a Fansly user from the authenticated Fansly Account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml delete /api/fansly/{fanslyAccount}/users/{account_id}/follow
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/users/{account_id}/follow:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: account_id
        description: The Fansly account ID to follow.
        example: "800000000000000002"
        required: true
        schema:
          type: string
    delete:
      summary: Unfollow User
      operationId: unfollowUser
      description: Unfollow a Fansly user from the authenticated Fansly Account.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    followerId: "800000000000000001"
                    accountId: "800000000000000002"
                    id: "200000000000000003"
                    createdAt: 1700000000000
                  _meta:
                    _credits:
                      used: 1
                      balance: 100000
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      followerId:
                        type: string
                        example: "800000000000000001"
                      accountId:
                        type: string
                        example: "800000000000000002"
                      id:
                        type: string
                        example: "200000000000000003"
                      createdAt:
                        type: integer
                        example: 1700000000000
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 100000
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Users
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Unmute User (/api-reference/fansly/users/unmute-user)

Unmute a Fansly user for the authenticated Fansly Account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-fansly-docs/openapi.yaml delete /api/fansly/{fanslyAccount}/users/{account_id}/mute
openapi: 3.0.3
info:
  title: Fansly API Documentation
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: Account
    description: Endpoints for your linked Fansly accounts
  - name: Chat Messages
    description: Endpoints for Fansly chats (messaging groups)
  - name: Chats
    description: Endpoints for Fansly chats (messaging groups)
  - name: Connect Fansly Account
    description: ""
  - name: Earnings
    description: Endpoints for Fansly Earnings — wallets, balances, transactions,
      payouts, and statements.
  - name: Followers
    description: Endpoints for Fansly followers.
  - name: Following
    description: Endpoints for the accounts a Fansly Account is following.
  - name: Lists
    description: Endpoints for Fansly subscriber/fan lists (e.g. "VIP", "Spenders").
  - name: Mass Messaging
    description: Endpoints for Fansly mass messages (broadcasts) — send one message
      to many recipients at once, and manage scheduled broadcasts.
  - name: Media
    description: Upload media for use in Fansly posts and messages
  - name: Posts
    description: Endpoints for Fansly wall posts.
  - name: Profile Statistics
    description: Endpoints for Fansly Profile Statistics (viewer engagement insights).
  - name: Subscribers
    description: Endpoints for Fansly subscribers and subscription tiers.
  - name: Subscription Discounts
    description: Endpoints for Fansly subscription discounts (shown as "Gift Links"
      in the Fansly Dashboard).
  - name: Top Supporters
    description: Endpoints for the Fansly "Top Supporters" view — see who spends the
      most and what they spend on.
  - name: Tracking Links
    description: Endpoints for Fansly tracking links — per-source attribution links
      (e.g. "Twitter bio", "FYP", "Search").
  - name: Users
    description: APIs for fetching Fansly users
  - name: Walls
    description: Endpoints for Fansly walls — the tabbed feeds on a creator profile
      that posts are published to.
paths:
  /api/fansly/{fanslyAccount}/users/{account_id}/mute:
    parameters:
      - in: path
        name: fanslyAccount
        description: The Fansly Account ID
        example: fansly_acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: account_id
        description: The Fansly account ID to mute.
        example: "800000000000000002"
        required: true
        schema:
          type: string
    delete:
      summary: Unmute User
      operationId: unmuteUser
      description: Unmute a Fansly user for the authenticated Fansly Account.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    accountId: "800000000000000001"
                    ignoredId: "800000000000000002"
                    ignoreFlags: 0
                  _meta:
                    _credits:
                      used: 1
                      balance: 100000
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      accountId:
                        type: string
                        example: "800000000000000001"
                      ignoredId:
                        type: string
                        example: "800000000000000002"
                      ignoreFlags:
                        type: integer
                        example: 0
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 100000
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Users
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Disconnect Account (/api-reference/account/disconnect-account)

Disconnect an OnlyFans account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/accounts/{id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/accounts/{id}:
    parameters:
      - in: path
        name: id
        description: The ID of the account.
        example: dolorem
        required: true
        schema:
          type: string
    delete:
      summary: Disconnect Account
      operationId: disconnectAccount
      description: Disconnect an OnlyFans account.
      parameters: []
      responses:
        "204":
          description: Success
          content:
            application/json:
              schema:
                type: object
                nullable: true
      tags:
        - Account
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Current Account (/api-reference/account/get-current-account)

Get OnlyFans Profile details for the currently used Account

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/me
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/me:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Current Account
      operationId: getCurrentAccount
      description: Get OnlyFans Profile details for the currently used Account
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    view: f
                    isAuth: true
                    ip: 127.0.0.1
                    csrf: csrf_token
                    upload:
                      geoUploadArgs:
                        preset: of_beta
                        protected_preset: of_drm
                        preset_png: of_png
                        isDelay: true
                        needThumbs: true
                        additional:
                          user: "123"
                    avatar: https://public.onlyfans.com/files/w/w6/w6g/.../123/avatar.jpg
                    avatarThumbs:
                      c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/w/w6/w6g/.../123/avatar.jpg
                      c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/w/w6/w6g/.../123/avatar.jpg
                    header: https://public.onlyfans.com/files/k/kk/kk6/.../123/header_image.jpg
                    headerSize:
                      width: 760
                      height: 570
                    headerThumbs:
                      w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/k/kk/kk6/.../123/header_image.jpg
                      w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/k/kk/kk6/.../123/header_image.jpg
                    id: 123
                    name: name
                    username: username
                    canLookStory: true
                    canCommentStory: true
                    hasNotViewedStory: false
                    isVerified: true
                    canPayInternal: true
                    hasScheduledStream: false
                    hasStream: false
                    hasStories: false
                    tipsEnabled: true
                    tipsTextEnabled: true
                    tipsMin: 5
                    tipsMinInternal: 1
                    tipsMax: 200
                    canEarn: true
                    canAddSubscriber: false
                    subscribePrice: 0
                    hasStripe: false
                    isStripeExist: false
                    subscriptionBundles: []
                    canSendChatToAll: true
                    creditsMin: 10
                    creditsMax: 200
                    isPaywallPassed: true
                    canCreateLists: true
                    joinDate: 2025-01-01T00:00:00+00:00
                    isReferrerAllowed: true
                    about: ""
                    isMarkdownDisabledForAbout: true
                    website: https://onlyfans.com
                    wishlist: null
                    location: null
                    postsCount: 2
                    archivedPostsCount: 0
                    privateArchivedPostsCount: 0
                    photosCount: 0
                    videosCount: 0
                    audiosCount: 0
                    mediasCount: 0
                    lastSeen: 2025-01-01T00:00:00+00:00
                    favoritesCount: 0
                    favoritedCount: 0
                    showPostsInFeed: true
                    canReceiveChatMessage: false
                    isPerformer: true
                    isRealPerformer: false
                    isSpotifyConnected: false
                    subscribersCount: 2
                    hasPinnedPosts: true
                    hasLabels: true
                    canChat: true
                    avatarHeaderConverterUpload: true
                    newTagsCount: 0
                    hasTags: false
                    isPrivateRestriction: false
                    showSubscribersCount: false
                    showMediaCount: true
                    subscribedByData: null
                    subscribedOnData: null
                    canCreatePromotion: false
                    canCreateTrial: false
                    isAdultContent: false
                    canTrialSend: false
                    hasLinks: false
                    hasFriends: false
                    firstPublishedPostDate: 2025-01-01T00:00:00+00:00
                    isSpringConnected: false
                    hasNewTicketReplies:
                      open: false
                      solved: false
                      closed: false
                      appeal_form: false
                    hasInternalPayments: false
                    isCreditsEnabled: true
                    creditBalance: 0
                    isMakePayment: false
                    isAgeVerified: false
                    ageVerificationRequired: false
                    isOtpEnabled: true
                    email: user@example.com
                    isEmailChecked: true
                    isLegalApprovedAllowed: true
                    isTwitterConnected: false
                    twitterUsername: TwitterUsername
                    isAllowTweets: false
                    isPaymentCardConnected: true
                    isVisibleOnline: true
                    subscribesCount: 61
                    canPinPost: true
                    hasNewAlerts: false
                    hasNewHints: true
                    hasNewChangedPriceSubscriptions: true
                    notificationsCount: 4
                    hasSystemNotifications: false
                    chatMessagesCount: 57
                    countPinnedChat: 0
                    isWantComments: true
                    watermarkText: OnlyFans.com/username
                    hasWatermarkPhoto: true
                    hasWatermarkVideo: true
                    watermarkPosition: bottom_right
                    advBlock:
                      - banners
                    hasPurchasedPosts: false
                    isEmailRequired: false
                    payoutLegalApproveState: approved
                    enabledImageEditorForChat: true
                    paidFeed: false
                    isRealCardConnected: true
                    countPriorityChat: 35
                    hasScenario: false
                    wsUrl: wss://ws2.onlyfans.com/ws3/03
                    wsAuthToken: ws_auth_token
                    canAddCard: true
                    unreadTips: 0
                    isWalletAutorecharge: false
                    walletAutorechargeAmount: 0
                    walletAutorechargeMin: 0
                    walletFirstRebills: false
                    canAlternativeWalletTopUp: false
                    needIVApprove: false
                    ivStatus: approved
                    ivFailReason: null
                    ivCountry: US
                    ivFlow: default
                    faceIdRegular: []
                    isVerifiedReason: false
                    canReceiveManualPayout: true
                    canReceiveStripePayout: false
                    isNeedConfirmPayout: false
                    canStreaming: false
                    isScheduledStreamsAllowed: false
                    canMakeExpirePosts: true
                    trialMaxDays: 7
                    trialMaxExpiresDays: 30
                    messageMinPrice: 3
                    messageMaxPrice: 100
                    postMinPrice: 3
                    postMaxPrice: 100
                    subscribeMinPrice: 4.99
                    subscribeMaxPrice: 50
                    canAddStory: true
                    canCreateFundRaising: true
                    minFundRaisingTarget: 10
                    maxFundRaisingTarget: 10000
                    ivHideForPerformers: false
                    canChangeContentPrice: true
                    payoutType: bank_ebics_sepa
                    isVatRequired: false
                    isCountryVatRefundable: false
                    isCountryVatNumberCollect: false
                    vatNumberName: VAT
                    isCountryWithVat: false
                    connectedOfAccounts: []
                    canConnectOfAccount: true
                    pinnedPostsCount: 1
                    maxPinnedPostsCount: 5
                    isDeleteInitiated: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999841
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49999
                properties:
                  data:
                    type: object
                    properties:
                      view:
                        type: string
                        example: f
                      isAuth:
                        type: boolean
                        example: true
                      ip:
                        type: string
                        example: 127.0.0.1
                      csrf:
                        type: string
                        example: csrf_token
                      upload:
                        type: object
                        properties:
                          geoUploadArgs:
                            type: object
                            properties:
                              preset:
                                type: string
                                example: of_beta
                              protected_preset:
                                type: string
                                example: of_drm
                              preset_png:
                                type: string
                                example: of_png
                              isDelay:
                                type: boolean
                                example: true
                              needThumbs:
                                type: boolean
                                example: true
                              additional:
                                type: object
                                properties:
                                  user:
                                    type: string
                                    example: "123"
                      avatar:
                        type: string
                        example: https://public.onlyfans.com/files/w/w6/w6g/.../123/avatar.jpg
                      avatarThumbs:
                        type: object
                        properties:
                          c50:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/c50/w/w6/w6g/.../123/avatar.jpg
                          c144:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/c144/w/w6/w6g/.../123/avatar.jpg
                      header:
                        type: string
                        example: https://public.onlyfans.com/files/k/kk/kk6/.../123/header_image.jpg
                      headerSize:
                        type: object
                        properties:
                          width:
                            type: integer
                            example: 760
                          height:
                            type: integer
                            example: 570
                      headerThumbs:
                        type: object
                        properties:
                          w480:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/w480/k/kk/kk6/.../123/header_image.jpg
                          w760:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/w760/k/kk/kk6/.../123/header_image.jpg
                      id:
                        type: integer
                        example: 123
                      name:
                        type: string
                        example: name
                      username:
                        type: string
                        example: username
                      canLookStory:
                        type: boolean
                        example: true
                      canCommentStory:
                        type: boolean
                        example: true
                      hasNotViewedStory:
                        type: boolean
                        example: false
                      isVerified:
                        type: boolean
                        example: true
                      canPayInternal:
                        type: boolean
                        example: true
                      hasScheduledStream:
                        type: boolean
                        example: false
                      hasStream:
                        type: boolean
                        example: false
                      hasStories:
                        type: boolean
                        example: false
                      tipsEnabled:
                        type: boolean
                        example: true
                      tipsTextEnabled:
                        type: boolean
                        example: true
                      tipsMin:
                        type: integer
                        example: 5
                      tipsMinInternal:
                        type: integer
                        example: 1
                      tipsMax:
                        type: integer
                        example: 200
                      canEarn:
                        type: boolean
                        example: true
                      canAddSubscriber:
                        type: boolean
                        example: false
                      subscribePrice:
                        type: integer
                        example: 0
                      hasStripe:
                        type: boolean
                        example: false
                      isStripeExist:
                        type: boolean
                        example: false
                      subscriptionBundles:
                        type: array
                        example: []
                      canSendChatToAll:
                        type: boolean
                        example: true
                      creditsMin:
                        type: integer
                        example: 10
                      creditsMax:
                        type: integer
                        example: 200
                      isPaywallPassed:
                        type: boolean
                        example: true
                      canCreateLists:
                        type: boolean
                        example: true
                      joinDate:
                        type: string
                        example: 2025-01-01T00:00:00+00:00
                      isReferrerAllowed:
                        type: boolean
                        example: true
                      about:
                        type: string
                        example: ""
                      isMarkdownDisabledForAbout:
                        type: boolean
                        example: true
                      website:
                        type: string
                        example: https://onlyfans.com
                      wishlist:
                        type: string
                        example: null
                        nullable: true
                      location:
                        type: string
                        example: null
                        nullable: true
                      postsCount:
                        type: integer
                        example: 2
                      archivedPostsCount:
                        type: integer
                        example: 0
                      privateArchivedPostsCount:
                        type: integer
                        example: 0
                      photosCount:
                        type: integer
                        example: 0
                      videosCount:
                        type: integer
                        example: 0
                      audiosCount:
                        type: integer
                        example: 0
                      mediasCount:
                        type: integer
                        example: 0
                      lastSeen:
                        type: string
                        example: 2025-01-01T00:00:00+00:00
                      favoritesCount:
                        type: integer
                        example: 0
                      favoritedCount:
                        type: integer
                        example: 0
                      showPostsInFeed:
                        type: boolean
                        example: true
                      canReceiveChatMessage:
                        type: boolean
                        example: false
                      isPerformer:
                        type: boolean
                        example: true
                      isRealPerformer:
                        type: boolean
                        example: false
                      isSpotifyConnected:
                        type: boolean
                        example: false
                      subscribersCount:
                        type: integer
                        example: 2
                      hasPinnedPosts:
                        type: boolean
                        example: true
                      hasLabels:
                        type: boolean
                        example: true
                      canChat:
                        type: boolean
                        example: true
                      avatarHeaderConverterUpload:
                        type: boolean
                        example: true
                      newTagsCount:
                        type: integer
                        example: 0
                      hasTags:
                        type: boolean
                        example: false
                      isPrivateRestriction:
                        type: boolean
                        example: false
                      showSubscribersCount:
                        type: boolean
                        example: false
                      showMediaCount:
                        type: boolean
                        example: true
                      subscribedByData:
                        type: string
                        example: null
                        nullable: true
                      subscribedOnData:
                        type: string
                        example: null
                        nullable: true
                      canCreatePromotion:
                        type: boolean
                        example: false
                      canCreateTrial:
                        type: boolean
                        example: false
                      isAdultContent:
                        type: boolean
                        example: false
                      canTrialSend:
                        type: boolean
                        example: false
                      hasLinks:
                        type: boolean
                        example: false
                      hasFriends:
                        type: boolean
                        example: false
                      firstPublishedPostDate:
                        type: string
                        example: 2025-01-01T00:00:00+00:00
                      isSpringConnected:
                        type: boolean
                        example: false
                      hasNewTicketReplies:
                        type: object
                        properties:
                          open:
                            type: boolean
                            example: false
                          solved:
                            type: boolean
                            example: false
                          closed:
                            type: boolean
                            example: false
                          appeal_form:
                            type: boolean
                            example: false
                      hasInternalPayments:
                        type: boolean
                        example: false
                      isCreditsEnabled:
                        type: boolean
                        example: true
                      creditBalance:
                        type: integer
                        example: 0
                      isMakePayment:
                        type: boolean
                        example: false
                      isAgeVerified:
                        type: boolean
                        example: false
                      ageVerificationRequired:
                        type: boolean
                        example: false
                      isOtpEnabled:
                        type: boolean
                        example: true
                      email:
                        type: string
                        example: user@example.com
                      isEmailChecked:
                        type: boolean
                        example: true
                      isLegalApprovedAllowed:
                        type: boolean
                        example: true
                      isTwitterConnected:
                        type: boolean
                        example: false
                      twitterUsername:
                        type: string
                        example: TwitterUsername
                      isAllowTweets:
                        type: boolean
                        example: false
                      isPaymentCardConnected:
                        type: boolean
                        example: true
                      isVisibleOnline:
                        type: boolean
                        example: true
                      subscribesCount:
                        type: integer
                        example: 61
                      canPinPost:
                        type: boolean
                        example: true
                      hasNewAlerts:
                        type: boolean
                        example: false
                      hasNewHints:
                        type: boolean
                        example: true
                      hasNewChangedPriceSubscriptions:
                        type: boolean
                        example: true
                      notificationsCount:
                        type: integer
                        example: 4
                      hasSystemNotifications:
                        type: boolean
                        example: false
                      chatMessagesCount:
                        type: integer
                        example: 57
                      countPinnedChat:
                        type: integer
                        example: 0
                      isWantComments:
                        type: boolean
                        example: true
                      watermarkText:
                        type: string
                        example: OnlyFans.com/username
                      hasWatermarkPhoto:
                        type: boolean
                        example: true
                      hasWatermarkVideo:
                        type: boolean
                        example: true
                      watermarkPosition:
                        type: string
                        example: bottom_right
                      advBlock:
                        type: array
                        example:
                          - banners
                        items:
                          type: string
                      hasPurchasedPosts:
                        type: boolean
                        example: false
                      isEmailRequired:
                        type: boolean
                        example: false
                      payoutLegalApproveState:
                        type: string
                        example: approved
                      enabledImageEditorForChat:
                        type: boolean
                        example: true
                      paidFeed:
                        type: boolean
                        example: false
                      isRealCardConnected:
                        type: boolean
                        example: true
                      countPriorityChat:
                        type: integer
                        example: 35
                      hasScenario:
                        type: boolean
                        example: false
                      wsUrl:
                        type: string
                        example: wss://ws2.onlyfans.com/ws3/03
                      wsAuthToken:
                        type: string
                        example: ws_auth_token
                      canAddCard:
                        type: boolean
                        example: true
                      unreadTips:
                        type: integer
                        example: 0
                      isWalletAutorecharge:
                        type: boolean
                        example: false
                      walletAutorechargeAmount:
                        type: integer
                        example: 0
                      walletAutorechargeMin:
                        type: integer
                        example: 0
                      walletFirstRebills:
                        type: boolean
                        example: false
                      canAlternativeWalletTopUp:
                        type: boolean
                        example: false
                      needIVApprove:
                        type: boolean
                        example: false
                      ivStatus:
                        type: string
                        example: approved
                      ivFailReason:
                        type: string
                        example: null
                        nullable: true
                      ivCountry:
                        type: string
                        example: US
                      ivFlow:
                        type: string
                        example: default
                      faceIdRegular:
                        type: array
                        example: []
                      isVerifiedReason:
                        type: boolean
                        example: false
                      canReceiveManualPayout:
                        type: boolean
                        example: true
                      canReceiveStripePayout:
                        type: boolean
                        example: false
                      isNeedConfirmPayout:
                        type: boolean
                        example: false
                      canStreaming:
                        type: boolean
                        example: false
                      isScheduledStreamsAllowed:
                        type: boolean
                        example: false
                      canMakeExpirePosts:
                        type: boolean
                        example: true
                      trialMaxDays:
                        type: integer
                        example: 7
                      trialMaxExpiresDays:
                        type: integer
                        example: 30
                      messageMinPrice:
                        type: integer
                        example: 3
                      messageMaxPrice:
                        type: integer
                        example: 100
                      postMinPrice:
                        type: integer
                        example: 3
                      postMaxPrice:
                        type: integer
                        example: 100
                      subscribeMinPrice:
                        type: number
                        example: 4.99
                      subscribeMaxPrice:
                        type: integer
                        example: 50
                      canAddStory:
                        type: boolean
                        example: true
                      canCreateFundRaising:
                        type: boolean
                        example: true
                      minFundRaisingTarget:
                        type: integer
                        example: 10
                      maxFundRaisingTarget:
                        type: integer
                        example: 10000
                      ivHideForPerformers:
                        type: boolean
                        example: false
                      canChangeContentPrice:
                        type: boolean
                        example: true
                      payoutType:
                        type: string
                        example: bank_ebics_sepa
                      isVatRequired:
                        type: boolean
                        example: false
                      isCountryVatRefundable:
                        type: boolean
                        example: false
                      isCountryVatNumberCollect:
                        type: boolean
                        example: false
                      vatNumberName:
                        type: string
                        example: VAT
                      isCountryWithVat:
                        type: boolean
                        example: false
                      connectedOfAccounts:
                        type: array
                        example: []
                      canConnectOfAccount:
                        type: boolean
                        example: true
                      pinnedPostsCount:
                        type: integer
                        example: 1
                      maxPinnedPostsCount:
                        type: integer
                        example: 5
                      isDeleteInitiated:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999841
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49999
      tags:
        - Account
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Model Start Date (/api-reference/account/get-model-start-date)

Get the start date of the model (the date+time monetization was enabled)

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/me/model-start-date
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/me/model-start-date:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Model Start Date
      operationId: getModelStartDate
      description: Get the start date of the model (the date+time monetization was enabled)
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    startDate: 2025-01-01 01:01:01
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999841
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999998
                      remaining_day: 49998
                properties:
                  data:
                    type: object
                    properties:
                      startDate:
                        type: string
                        example: 2025-01-01 01:01:01
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999841
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999998
                          remaining_day:
                            type: integer
                            example: 49998
      tags:
        - Account
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Top Percentage (/api-reference/account/get-top-percentage)

Get the top percentage of the model (e.g., top 0.02% of all creators)

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/me/top-percentage
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/me/top-percentage:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Top Percentage
      operationId: getTopPercentage
      description: Get the top percentage of the model (e.g., top 0.02% of all creators)
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    top_percentage: 0.02
                    message: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999911
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 997
                      remaining_day: 49912
                properties:
                  data:
                    type: object
                    properties:
                      top_percentage:
                        type: number
                        example: 0.02
                      message:
                        type: string
                        example: null
                        nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999911
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 49912
      tags:
        - Account
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Accounts (/api-reference/account/list-accounts)

List all connected OnlyFans accounts.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/accounts
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/accounts:
    get:
      summary: List Accounts
      operationId: listAccounts
      description: List all connected OnlyFans accounts.
      parameters:
        - in: query
          name: onlyfans_id
          description: Optionally, filter by the OnlyFans ID
          example: 1234567890
          required: false
          schema:
            type: string
            description: Optionally, filter by the OnlyFans ID
            example: 1234567890
            nullable: true
        - in: query
          name: onlyfans_username
          description: Optionally, filter by the OnlyFans username
          example: username
          required: false
          schema:
            type: string
            description: Optionally, filter by the OnlyFans username
            example: username
            nullable: true
        - in: query
          name: onlyfans_email
          description: Optionally, filter by the OnlyFans email
          example: creator@example.com
          required: false
          schema:
            type: string
            description: Optionally, filter by the OnlyFans email
            example: creator@example.com
            nullable: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      example: acct_123
                    onlyfans_id:
                      type: integer
                      example: 123
                    onlyfans_username:
                      type: string
                      example: user
                    onlyfans_email:
                      type: string
                      example: user@example.com
                    is_authenticated:
                      type: boolean
                      example: true
                    authentication_progress:
                      type: string
                      example: signed_in
                    display_name:
                      type: string
                      example: oft
                    onlyfans_user_data:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 123
                        ip:
                          type: string
                          example: 127.0.0.1
                        csrf:
                          type: string
                          example: csrf
                        name:
                          type: string
                          example: Name
                        view:
                          type: string
                          example: f
                        about:
                          type: string
                          example: <p>about</p>
                        email:
                          type: string
                          example: user@example.com
                        wsUrl:
                          type: string
                          example: wss://ws2.onlyfans.com/ws3/03
                        avatar:
                          type: string
                          example: https://example.com
                        header:
                          type: string
                          example: https://example.com
                        isAuth:
                          type: boolean
                          example: true
                        ivFlow:
                          type: string
                          example: default
                        upload:
                          type: object
                          properties:
                            geoUploadArgs:
                              type: object
                              properties:
                                preset:
                                  type: string
                                  example: of_beta
                                isDelay:
                                  type: boolean
                                  example: true
                                additional:
                                  type: object
                                  properties:
                                    user:
                                      type: string
                                      example: "123"
                                needThumbs:
                                  type: boolean
                                  example: true
                                preset_png:
                                  type: string
                                  example: of_png
                                protected_preset:
                                  type: string
                                  example: of_drm
                        canChat:
                          type: boolean
                          example: true
                        hasTags:
                          type: boolean
                          example: false
                        website:
                          type: string
                          example: null
                          nullable: true
                        advBlock:
                          type: array
                          example:
                            - subscribe_offers
                          items:
                            type: string
                        ivStatus:
                          type: string
                          example: approved
                        joinDate:
                          type: string
                          example: 2025-04-05T00:00:00+00:00
                        lastSeen:
                          type: string
                          example: 2025-05-16T10:09:48+00:00
                        location:
                          type: string
                          example: null
                          nullable: true
                        paidFeed:
                          type: boolean
                          example: false
                        username:
                          type: string
                          example: user
                        wishlist:
                          type: string
                          example: null
                          nullable: true
                        hasLabels:
                          type: boolean
                          example: false
                        ivCountry:
                          type: string
                          example: US
                        canAddCard:
                          type: boolean
                          example: true
                        canPinPost:
                          type: boolean
                          example: true
                        creditsMax:
                          type: integer
                          example: 200
                        creditsMin:
                          type: integer
                          example: 10
                        headerSize:
                          type: object
                          properties:
                            width:
                              type: integer
                              example: 2126
                            height:
                              type: integer
                              example: 1535
                        isVerified:
                          type: boolean
                          example: false
                        postsCount:
                          type: integer
                          example: 0
                        audiosCount:
                          type: integer
                          example: 0
                        hasNewHints:
                          type: boolean
                          example: true
                        hasScenario:
                          type: boolean
                          example: true
                        isPerformer:
                          type: boolean
                          example: false
                        mediasCount:
                          type: integer
                          example: 0
                        photosCount:
                          type: integer
                          example: 0
                        videosCount:
                          type: integer
                          example: 0
                        wsAuthToken:
                          type: string
                          example: wsAuthToken
                        avatarThumbs:
                          type: object
                          properties:
                            c50:
                              type: string
                              example: https://example.com
                            c144:
                              type: string
                              example: https://example.com
                        canLookStory:
                          type: boolean
                          example: true
                        hasNewAlerts:
                          type: boolean
                          example: false
                        headerThumbs:
                          type: object
                          properties:
                            w480:
                              type: string
                              example: https://example.com
                            w760:
                              type: string
                              example: https://example.com
                        isOtpEnabled:
                          type: boolean
                          example: true
                        ivFailReason:
                          type: string
                          example: null
                          nullable: true
                        newTagsCount:
                          type: integer
                          example: 0
                        creditBalance:
                          type: integer
                          example: 0
                        faceIdRegular:
                          type: array
                          example: []
                        isAgeVerified:
                          type: boolean
                          example: false
                        isAllowTweets:
                          type: boolean
                          example: false
                        isMakePayment:
                          type: boolean
                          example: false
                        needIVApprove:
                          type: boolean
                          example: false
                        watermarkText:
                          type: string
                          example: OnlyFans.com/user
                        canCreateLists:
                          type: boolean
                          example: true
                        canPayInternal:
                          type: boolean
                          example: true
                        favoritedCount:
                          type: integer
                          example: 0
                        favoritesCount:
                          type: integer
                          example: 0
                        hasPinnedPosts:
                          type: boolean
                          example: false
                        isEmailChecked:
                          type: boolean
                          example: true
                        isWantComments:
                          type: boolean
                          example: true
                        canCommentStory:
                          type: boolean
                          example: true
                        countPinnedChat:
                          type: integer
                          example: 0
                        isEmailRequired:
                          type: boolean
                          example: false
                        isPaywallPassed:
                          type: boolean
                          example: true
                        isRealPerformer:
                          type: boolean
                          example: false
                        isVisibleOnline:
                          type: boolean
                          example: true
                        showPostsInFeed:
                          type: boolean
                          example: true
                        subscribesCount:
                          type: integer
                          example: 123
                        twitterUsername:
                          type: string
                          example: user
                        canSendChatToAll:
                          type: boolean
                          example: false
                        isCreditsEnabled:
                          type: boolean
                          example: true
                        pinnedPostsCount:
                          type: integer
                          example: 0
                        subscribersCount:
                          type: integer
                          example: 123
                        chatMessagesCount:
                          type: integer
                          example: 123
                        countPriorityChat:
                          type: integer
                          example: 123
                        hasNotViewedStory:
                          type: boolean
                          example: false
                        hasPurchasedPosts:
                          type: boolean
                          example: false
                        hasWatermarkPhoto:
                          type: boolean
                          example: true
                        hasWatermarkVideo:
                          type: boolean
                          example: true
                        isDeleteInitiated:
                          type: boolean
                          example: false
                        isReferrerAllowed:
                          type: boolean
                          example: false
                        watermarkPosition:
                          type: string
                          example: bottom_right
                        archivedPostsCount:
                          type: integer
                          example: 0
                        isSpotifyConnected:
                          type: boolean
                          example: false
                        isTwitterConnected:
                          type: boolean
                          example: false
                        notificationsCount:
                          type: integer
                          example: 123
                        walletFirstRebills:
                          type: boolean
                          example: false
                        canConnectOfAccount:
                          type: boolean
                          example: true
                        connectedOfAccounts:
                          type: array
                          example: []
                        hasInternalPayments:
                          type: boolean
                          example: false
                        hasNewTicketReplies:
                          type: object
                          properties:
                            open:
                              type: boolean
                              example: false
                            closed:
                              type: boolean
                              example: false
                            solved:
                              type: boolean
                              example: false
                        isRealCardConnected:
                          type: boolean
                          example: true
                        maxPinnedPostsCount:
                          type: integer
                          example: 5
                        isWalletAutorecharge:
                          type: boolean
                          example: false
                        canReceiveChatMessage:
                          type: boolean
                          example: false
                        walletAutorechargeMin:
                          type: integer
                          example: 0
                        hasSystemNotifications:
                          type: boolean
                          example: false
                        isLegalApprovedAllowed:
                          type: boolean
                          example: true
                        isPaymentCardConnected:
                          type: boolean
                          example: true
                        ageVerificationRequired:
                          type: boolean
                          example: false
                        payoutLegalApproveState:
                          type: string
                          example: rejected
                        walletAutorechargeAmount:
                          type: integer
                          example: 0
                        canAlternativeWalletTopUp:
                          type: boolean
                          example: false
                        enabledImageEditorForChat:
                          type: boolean
                          example: true
                        privateArchivedPostsCount:
                          type: integer
                          example: 0
                        isMarkdownDisabledForAbout:
                          type: boolean
                          example: true
                        avatarHeaderConverterUpload:
                          type: boolean
                          example: true
                        hasNewChangedPriceSubscriptions:
                          type: boolean
                          example: false
                example:
                  - id: acct_123
                    onlyfans_id: 123
                    onlyfans_username: user
                    onlyfans_email: user@example.com
                    is_authenticated: true
                    authentication_progress: signed_in
                    display_name: oft
                    onlyfans_user_data:
                      id: 123
                      ip: 127.0.0.1
                      csrf: csrf
                      name: Name
                      view: f
                      about: <p>about</p>
                      email: user@example.com
                      wsUrl: wss://ws2.onlyfans.com/ws3/03
                      avatar: https://example.com
                      header: https://example.com
                      isAuth: true
                      ivFlow: default
                      upload:
                        geoUploadArgs:
                          preset: of_beta
                          isDelay: true
                          additional:
                            user: "123"
                          needThumbs: true
                          preset_png: of_png
                          protected_preset: of_drm
                      canChat: true
                      hasTags: false
                      website: null
                      advBlock:
                        - subscribe_offers
                      ivStatus: approved
                      joinDate: 2025-04-05T00:00:00+00:00
                      lastSeen: 2025-05-16T10:09:48+00:00
                      location: null
                      paidFeed: false
                      username: user
                      wishlist: null
                      hasLabels: false
                      ivCountry: US
                      canAddCard: true
                      canPinPost: true
                      creditsMax: 200
                      creditsMin: 10
                      headerSize:
                        width: 2126
                        height: 1535
                      isVerified: false
                      postsCount: 0
                      audiosCount: 0
                      hasNewHints: true
                      hasScenario: true
                      isPerformer: false
                      mediasCount: 0
                      photosCount: 0
                      videosCount: 0
                      wsAuthToken: wsAuthToken
                      avatarThumbs:
                        c50: https://example.com
                        c144: https://example.com
                      canLookStory: true
                      hasNewAlerts: false
                      headerThumbs:
                        w480: https://example.com
                        w760: https://example.com
                      isOtpEnabled: true
                      ivFailReason: null
                      newTagsCount: 0
                      creditBalance: 0
                      faceIdRegular: []
                      isAgeVerified: false
                      isAllowTweets: false
                      isMakePayment: false
                      needIVApprove: false
                      watermarkText: OnlyFans.com/user
                      canCreateLists: true
                      canPayInternal: true
                      favoritedCount: 0
                      favoritesCount: 0
                      hasPinnedPosts: false
                      isEmailChecked: true
                      isWantComments: true
                      canCommentStory: true
                      countPinnedChat: 0
                      isEmailRequired: false
                      isPaywallPassed: true
                      isRealPerformer: false
                      isVisibleOnline: true
                      showPostsInFeed: true
                      subscribesCount: 123
                      twitterUsername: user
                      canSendChatToAll: false
                      isCreditsEnabled: true
                      pinnedPostsCount: 0
                      subscribersCount: 123
                      chatMessagesCount: 123
                      countPriorityChat: 123
                      hasNotViewedStory: false
                      hasPurchasedPosts: false
                      hasWatermarkPhoto: true
                      hasWatermarkVideo: true
                      isDeleteInitiated: false
                      isReferrerAllowed: false
                      watermarkPosition: bottom_right
                      archivedPostsCount: 0
                      isSpotifyConnected: false
                      isTwitterConnected: false
                      notificationsCount: 123
                      walletFirstRebills: false
                      canConnectOfAccount: true
                      connectedOfAccounts: []
                      hasInternalPayments: false
                      hasNewTicketReplies:
                        open: false
                        closed: false
                        solved: false
                      isRealCardConnected: true
                      maxPinnedPostsCount: 5
                      isWalletAutorecharge: false
                      canReceiveChatMessage: false
                      walletAutorechargeMin: 0
                      hasSystemNotifications: false
                      isLegalApprovedAllowed: true
                      isPaymentCardConnected: true
                      ageVerificationRequired: false
                      payoutLegalApproveState: rejected
                      walletAutorechargeAmount: 0
                      canAlternativeWalletTopUp: false
                      enabledImageEditorForChat: true
                      privateArchivedPostsCount: 0
                      isMarkdownDisabledForAbout: true
                      avatarHeaderConverterUpload: true
                      hasNewChangedPriceSubscriptions: false
      tags:
        - Account
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Earnings Overview (/api-reference/analytics-summary/get-earnings-overview)

Get earnings overview by category for selected accounts within a date range. Returns total earnings, subscriptions, posts, messages, tips, streams, and content stats.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/analytics/summary/earnings
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/analytics/summary/earnings:
    post:
      summary: Get Earnings Overview
      operationId: getEarningsOverview
      description: Get earnings overview by category for selected accounts within a
        date range. Returns total earnings, subscriptions, posts, messages,
        tips, streams, and content stats.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  total_earnings: 15000.5
                  subscriptions: 8000
                  posts: 2500
                  messages: 3000
                  tips: 1300
                  streams: 200.5
                  total_accounts: 5
                  total_messages: 1250
                  total_images: 450
                  total_videos: 120
                properties:
                  total_earnings:
                    type: number
                    example: 15000.5
                  subscriptions:
                    type: number
                    example: 8000
                  posts:
                    type: number
                    example: 2500
                  messages:
                    type: number
                    example: 3000
                  tips:
                    type: number
                    example: 1300
                  streams:
                    type: number
                    example: 200.5
                  total_accounts:
                    type: integer
                    example: 5
                  total_messages:
                    type: integer
                    example: 1250
                  total_images:
                    type: integer
                    example: 450
                  total_videos:
                    type: integer
                    example: 120
      tags:
        - Analytics - Summary
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                account_ids:
                  type: array
                  description: Array of account prefixed IDs to get earnings for
                  example:
                    - acc_abc123
                    - acc_def456
                  items:
                    type: string
                start_date:
                  type: string
                  description: The start date (ISO 8601 format)
                  example: 2024-01-01
                end_date:
                  type: string
                  description: The end date (ISO 8601 format)
                  example: 2024-12-31
              required:
                - account_ids
                - start_date
                - end_date
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Historical Performance (/api-reference/analytics-summary/get-historical-performance)

Get historical earnings chart data for the team. Returns monthly aggregated revenue data for the specified time range.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/analytics/summary/historical
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/analytics/summary/historical:
    post:
      summary: Get Historical Performance
      operationId: getHistoricalPerformance
      description: Get historical earnings chart data for the team. Returns monthly
        aggregated revenue data for the specified time range.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    period:
                      type: string
                      example: 2024-01
                    value:
                      type: number
                      example: 5000
                example:
                  - period: 2024-01
                    value: 5000
                  - period: 2024-02
                    value: 5500
      tags:
        - Analytics - Summary
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                time_range:
                  type: string
                  description: The time range for historical data
                  example: 12m
                  enum:
                    - 3m
                    - 6m
                    - 12m
                    - ytd
                    - last-year
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Period Comparison (/api-reference/analytics-summary/get-period-comparison)

Compare two time periods to analyze performance changes. Returns summary, breakdown, and chart data for the comparison.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/analytics/summary/comparison
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/analytics/summary/comparison:
    post:
      summary: Get Period Comparison
      operationId: getPeriodComparison
      description: Compare two time periods to analyze performance changes. Returns
        summary, breakdown, and chart data for the comparison.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  summary:
                    period_a_total: 15000
                    period_b_total: 18000
                    change: 3000
                    change_percentage: 20
                  breakdown: []
                  chart_data: []
                  period_a_label: Q1 2024
                  period_b_label: Q2 2024
                properties:
                  summary:
                    type: object
                    properties:
                      period_a_total:
                        type: number
                        example: 15000
                      period_b_total:
                        type: number
                        example: 18000
                      change:
                        type: number
                        example: 3000
                      change_percentage:
                        type: number
                        example: 20
                  breakdown:
                    type: array
                    example: []
                  chart_data:
                    type: array
                    example: []
                  period_a_label:
                    type: string
                    example: Q1 2024
                  period_b_label:
                    type: string
                    example: Q2 2024
      tags:
        - Analytics - Summary
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                account_ids:
                  type: array
                  description: Array of account prefixed IDs to compare
                  example:
                    - acc_abc123
                    - acc_def456
                  items:
                    type: string
                period_a:
                  type: object
                  description: First period to compare
                  example:
                    start: 2024-01-01
                    end: 2024-03-31
                  properties:
                    start:
                      type: string
                      description: Must be a valid date.
                      example: 2026-07-20T18:25:09
                    end:
                      type: string
                      description: Must be a valid date. Must be a date after or equal to
                        <code>period_a.start</code>.
                      example: 2088-03-29
                  required:
                    - start
                    - end
                period_b:
                  type: object
                  description: Second period to compare
                  example:
                    start: 2024-04-01
                    end: 2024-06-30
                  properties:
                    start:
                      type: string
                      description: Must be a valid date.
                      example: 2026-07-20T18:25:09
                    end:
                      type: string
                      description: Must be a valid date. Must be a date after or equal to
                        <code>period_b.start</code>.
                      example: 2064-11-07
                  required:
                    - start
                    - end
                granularity:
                  type: string
                  description: Comparison granularity
                  example: months
                  enum:
                    - months
                    - quarters
                    - half_years
                    - years
                stat_type:
                  type: string
                  description: The statistic type to compare
                  example: totalEarnings
                  enum:
                    - totalEarnings
                    - subscriptions
                    - posts
                    - messages
                    - tips
                    - streams
              required:
                - account_ids
                - period_a
                - period_b
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Whoami (/api-reference/api-keys/whoami)

Get details about the currently used API Key & the relevant Team

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/whoami
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/whoami:
    get:
      summary: Whoami
      operationId: whoami
      description: Get details about the currently used API Key & the relevant Team
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  api_key:
                    name: Onboarding
                    last_used_at: 2025-05-23T15:51:52.000000Z
                    created_at: 2025-04-20T16:27:45.000000Z
                  team:
                    name: Personal Team
                    slug: personal-team-123
                properties:
                  api_key:
                    type: object
                    properties:
                      name:
                        type: string
                        example: Onboarding
                      last_used_at:
                        type: string
                        example: 2025-05-23T15:51:52.000000Z
                      created_at:
                        type: string
                        example: 2025-04-20T16:27:45.000000Z
                  team:
                    type: object
                    properties:
                      name:
                        type: string
                        example: Personal Team
                      slug:
                        type: string
                        example: personal-team-123
      tags:
        - API Keys
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Banned Words (/api-reference/banned-words/list-banned-words)

Get a paginated, filterable list of the OnlyFans banned words OFAPI screens against. Use the `risk_level` values (`strict_ban`, `risky`, `replace_soften`) with the `blockBannedWords` parameter on the send/edit message, post, and mass-message endpoints.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/banned-words
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/banned-words:
    get:
      summary: List Banned Words
      operationId: listBannedWords
      description: Get a paginated, filterable list of the OnlyFans banned words OFAPI
        screens against. Use the `risk_level` values (`strict_ban`, `risky`,
        `replace_soften`) with the `blockBannedWords` parameter on the send/edit
        message, post, and mass-message endpoints.
      parameters:
        - in: query
          name: category
          description: Filter by exact category, e.g. "Non-consensual acts". Must not be
            greater than 255 characters.
          example: null
          required: false
          schema:
            type: string
            description: Filter by exact category, e.g. "Non-consensual acts". Must not be
              greater than 255 characters.
            example: null
            nullable: true
        - in: query
          name: risk_level
          description: "Filter by risk level: `strict_ban`, `risky`, or `replace_soften`."
          example: strict_ban
          required: false
          schema:
            type: string
            description: "Filter by risk level: `strict_ban`, `risky`, or `replace_soften`."
            example: strict_ban
            enum:
              - strict_ban
              - risky
              - replace_soften
            nullable: true
        - in: query
          name: search
          description: Search within the word or its base form. Must not be greater than
            255 characters.
          example: null
          required: false
          schema:
            type: string
            description: Search within the word or its base form. Must not be greater than
              255 characters.
            example: null
            nullable: true
        - in: query
          name: per_page
          description: Number of words to return per page (1-100, default 50). Must be at
            least 1. Must not be greater than 100.
          example: 50
          required: false
          schema:
            type: integer
            description: Number of words to return per page (1-100, default 50). Must be at
              least 1. Must not be greater than 100.
            example: 50
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - word: abduct
                      base: abduct
                      category: Non-consensual acts
                      risk_level: strict_ban
                      safe_alternatives: Avoid entirely. If needed, use “consensual roleplay,”
                        “fantasy scenario,” “dominant/submissive (consensual).”
                      notes: null
                      regex_pattern: "[aA@4][^a-zA-Z0-9_]{0,2}[bB8][^a-zA-Z0-9_]{0,2}[dD][^a-zA-Z0-9_\
                        ]{0,2}[uUvV][^a-zA-Z0-9_]{0,2}[cC\\(][^a-zA-Z0-9_]{0,2}\
                        [tT7+]"
                    - word: ballbusting
                      base: ballbusting
                      category: BDSM & fetish terms (violent/extreme)
                      risk_level: risky
                      safe_alternatives: Use “impact play (consensual),” “intense roleplay.”
                      notes: null
                      regex_pattern: null
                    - word: drink
                      base: drink
                      category: Substances/intoxication
                      risk_level: replace_soften
                      safe_alternatives: Use “relaxed,” “wind-down,” “chill night.”
                      notes: null
                      regex_pattern: null
                  links:
                    first: https://app.onlyfansapi.com/api/banned-words?page=1
                    last: https://app.onlyfansapi.com/api/banned-words?page=34
                    prev: null
                    next: https://app.onlyfansapi.com/api/banned-words?page=2
                  meta:
                    current_page: 1
                    from: 1
                    last_page: 34
                    path: https://app.onlyfansapi.com/api/banned-words
                    per_page: 50
                    to: 50
                    total: 1668
                properties:
                  data:
                    type: array
                    example:
                      - word: abduct
                        base: abduct
                        category: Non-consensual acts
                        risk_level: strict_ban
                        safe_alternatives: Avoid entirely. If needed, use “consensual roleplay,”
                          “fantasy scenario,” “dominant/submissive
                          (consensual).”
                        notes: null
                        regex_pattern: "[aA@4][^a-zA-Z0-9_]{0,2}[bB8][^a-zA-Z0-9_]{0,2}[dD][^a-zA-Z0-9_\
                          ]{0,2}[uUvV][^a-zA-Z0-9_]{0,2}[cC\\(][^a-zA-Z0-9_]{0,\
                          2}[tT7+]"
                      - word: ballbusting
                        base: ballbusting
                        category: BDSM & fetish terms (violent/extreme)
                        risk_level: risky
                        safe_alternatives: Use “impact play (consensual),” “intense roleplay.”
                        notes: null
                        regex_pattern: null
                      - word: drink
                        base: drink
                        category: Substances/intoxication
                        risk_level: replace_soften
                        safe_alternatives: Use “relaxed,” “wind-down,” “chill night.”
                        notes: null
                        regex_pattern: null
                    items:
                      type: object
                      properties:
                        word:
                          type: string
                          example: abduct
                        base:
                          type: string
                          example: abduct
                        category:
                          type: string
                          example: Non-consensual acts
                        risk_level:
                          type: string
                          example: strict_ban
                        safe_alternatives:
                          type: string
                          example: Avoid entirely. If needed, use “consensual roleplay,” “fantasy
                            scenario,” “dominant/submissive (consensual).”
                        notes:
                          type: string
                          example: null
                          nullable: true
                        regex_pattern:
                          type: string
                          example: "[aA@4][^a-zA-Z0-9_]{0,2}[bB8][^a-zA-Z0-9_]{0,2}[dD][^a-zA-Z0-9_]{0,2}\
                            [uUvV][^a-zA-Z0-9_]{0,2}[cC\\(][^a-zA-Z0-9_]{0,2}[t\
                            T7+]"
                  links:
                    type: object
                    properties:
                      first:
                        type: string
                        example: https://app.onlyfansapi.com/api/banned-words?page=1
                      last:
                        type: string
                        example: https://app.onlyfansapi.com/api/banned-words?page=34
                      prev:
                        type: string
                        example: null
                        nullable: true
                      next:
                        type: string
                        example: https://app.onlyfansapi.com/api/banned-words?page=2
                  meta:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      from:
                        type: integer
                        example: 1
                      last_page:
                        type: integer
                        example: 34
                      path:
                        type: string
                        example: https://app.onlyfansapi.com/api/banned-words
                      per_page:
                        type: integer
                        example: 50
                      to:
                        type: integer
                        example: 50
                      total:
                        type: integer
                        example: 1668
      tags:
        - Banned Words
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Account Country Details (/api-reference/banking/get-account-country-details)

Returns the account owner's country details for banking, including country code, name, whether the country has states and zip codes, payout eligibility, and W9 form availability.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/banking/details/account-country
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/banking/details/account-country:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Account Country Details
      operationId: getAccountCountryDetails
      description: Returns the account owner's country details for banking, including
        country code, name, whether the country has states and zip codes, payout
        eligibility, and W9 form availability.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 212
                    code: US
                    name: United States of America
                    hasStates: true
                    hasZip: true
                    canPay: true
                    canHasW9Form: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000000008
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49956
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 212
                      code:
                        type: string
                        example: US
                      name:
                        type: string
                        example: United States of America
                      hasStates:
                        type: boolean
                        example: true
                      hasZip:
                        type: boolean
                        example: true
                      canPay:
                        type: boolean
                        example: true
                      canHasW9Form:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000000008
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49956
      tags:
        - Banking
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Bank Payout Details (/api-reference/banking/get-bank-payout-details)

Returns the account owner's bank payout details, including whether payout data is filled, available payout methods with their descriptions, and required bank fields.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/banking/details/bank
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/banking/details/bank:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Bank Payout Details
      operationId: getBankPayoutDetails
      description: Returns the account owner's bank payout details, including whether
        payout data is filled, available payout methods with their descriptions,
        and required bank fields.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    isPayoutDataFilled: true
                    payouts:
                      - code: bank_ebics_sepa
                        title: International Transfer (SEPA)
                        subtitle: Receive payouts directly to your bank account via SEPA payments
                        minPayoutSumm: 20
                        payoutTime: 1-3 business days
                        description: >-
                          No limits on number of daily withdrawals (No maximum)

                          Payouts are paid directly into your bank account via
                          the SEPA banking system

                          Any SEPA bank account
                        fields:
                          first_name:
                            readonly: true
                            value: "********"
                            label:
                              key: bank_recipient_name_title
                            maxlength: 255
                            oninput:
                              replace:
                                pattern: "[^ a-zA-Z0-9_-]"
                                flag: g
                          last_name:
                            readonly: true
                            value: "********"
                            label:
                              key: bank_recipient_last_name_title
                            maxlength: 255
                            oninput:
                              replace:
                                pattern: "[^ a-zA-Z0-9_-]"
                                flag: g
                          iban:
                            required: true
                            label:
                              key: bank_iban_title
                            regex:
                              pattern: ^[A-Za-z0-9]{1,34}$
                              flag: g
                            value: "********1234"
                          bic:
                            required: true
                            label:
                              key: bank_bic_swift_title
                            maxlength: 70
                            value: "********"
                          bank_name:
                            required: true
                            label:
                              key: bank_bank_name_title_new
                            maxlength: 70
                            value: Bank name
                          country:
                            label:
                              key: country_label
                            readonly: true
                            uionly: true
                            value: Country
                          address:
                            required: true
                            label:
                              key: bank_user_address_title
                            maxlength: 255
                            value: "********"
                          city:
                            required: true
                            label:
                              key: bank_user_city_title
                            maxlength: 255
                            value: City value
                          postal:
                            required: true
                            label:
                              key: bank_user_postal_zip_title
                            maxlength: 255
                            value: "********"
                        fieldsOrder:
                          - first_name
                          - last_name
                          - iban
                          - bic
                          - bank_name
                          - country
                          - address
                          - city
                          - postal
                        uiMapping:
                          title:
                            key: add_bank_page_title
                          alert:
                            text:
                              key: payout_add_bank_paxum_hint
                            class: info
                          btn_submit:
                            key: save_payout_details_button
                    payoutCode: bank_ebics_sepa
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000000006
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49954
                properties:
                  data:
                    type: object
                    properties:
                      isPayoutDataFilled:
                        type: boolean
                        example: true
                      payouts:
                        type: array
                        example:
                          - code: bank_ebics_sepa
                            title: International Transfer (SEPA)
                            subtitle: Receive payouts directly to your bank account via SEPA payments
                            minPayoutSumm: 20
                            payoutTime: 1-3 business days
                            description: >-
                              No limits on number of daily withdrawals (No
                              maximum)

                              Payouts are paid directly into your bank account
                              via the SEPA banking system

                              Any SEPA bank account
                            fields:
                              first_name:
                                readonly: true
                                value: "********"
                                label:
                                  key: bank_recipient_name_title
                                maxlength: 255
                                oninput:
                                  replace:
                                    pattern: "[^ a-zA-Z0-9_-]"
                                    flag: g
                              last_name:
                                readonly: true
                                value: "********"
                                label:
                                  key: bank_recipient_last_name_title
                                maxlength: 255
                                oninput:
                                  replace:
                                    pattern: "[^ a-zA-Z0-9_-]"
                                    flag: g
                              iban:
                                required: true
                                label:
                                  key: bank_iban_title
                                regex:
                                  pattern: ^[A-Za-z0-9]{1,34}$
                                  flag: g
                                value: "********1234"
                              bic:
                                required: true
                                label:
                                  key: bank_bic_swift_title
                                maxlength: 70
                                value: "********"
                              bank_name:
                                required: true
                                label:
                                  key: bank_bank_name_title_new
                                maxlength: 70
                                value: Bank name
                              country:
                                label:
                                  key: country_label
                                readonly: true
                                uionly: true
                                value: Country
                              address:
                                required: true
                                label:
                                  key: bank_user_address_title
                                maxlength: 255
                                value: "********"
                              city:
                                required: true
                                label:
                                  key: bank_user_city_title
                                maxlength: 255
                                value: City value
                              postal:
                                required: true
                                label:
                                  key: bank_user_postal_zip_title
                                maxlength: 255
                                value: "********"
                            fieldsOrder:
                              - first_name
                              - last_name
                              - iban
                              - bic
                              - bank_name
                              - country
                              - address
                              - city
                              - postal
                            uiMapping:
                              title:
                                key: add_bank_page_title
                              alert:
                                text:
                                  key: payout_add_bank_paxum_hint
                                class: info
                              btn_submit:
                                key: save_payout_details_button
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                              example: bank_ebics_sepa
                            title:
                              type: string
                              example: International Transfer (SEPA)
                            subtitle:
                              type: string
                              example: Receive payouts directly to your bank account via SEPA payments
                            minPayoutSumm:
                              type: integer
                              example: 20
                            payoutTime:
                              type: string
                              example: 1-3 business days
                            description:
                              type: string
                              example: >-
                                No limits on number of daily withdrawals (No
                                maximum)

                                Payouts are paid directly into your bank account
                                via the SEPA banking system

                                Any SEPA bank account
                            fields:
                              type: object
                              properties:
                                first_name:
                                  type: object
                                  properties:
                                    readonly:
                                      type: boolean
                                      example: true
                                    value:
                                      type: string
                                      example: "********"
                                    label:
                                      type: object
                                      properties:
                                        key:
                                          type: string
                                          example: bank_recipient_name_title
                                    maxlength:
                                      type: integer
                                      example: 255
                                    oninput:
                                      type: object
                                      properties:
                                        replace:
                                          type: object
                                          properties:
                                            pattern:
                                              type: string
                                              example: "[^ a-zA-Z0-9_-]"
                                            flag:
                                              type: string
                                              example: g
                                last_name:
                                  type: object
                                  properties:
                                    readonly:
                                      type: boolean
                                      example: true
                                    value:
                                      type: string
                                      example: "********"
                                    label:
                                      type: object
                                      properties:
                                        key:
                                          type: string
                                          example: bank_recipient_last_name_title
                                    maxlength:
                                      type: integer
                                      example: 255
                                    oninput:
                                      type: object
                                      properties:
                                        replace:
                                          type: object
                                          properties:
                                            pattern:
                                              type: string
                                              example: "[^ a-zA-Z0-9_-]"
                                            flag:
                                              type: string
                                              example: g
                                iban:
                                  type: object
                                  properties:
                                    required:
                                      type: boolean
                                      example: true
                                    label:
                                      type: object
                                      properties:
                                        key:
                                          type: string
                                          example: bank_iban_title
                                    regex:
                                      type: object
                                      properties:
                                        pattern:
                                          type: string
                                          example: ^[A-Za-z0-9]{1,34}$
                                        flag:
                                          type: string
                                          example: g
                                    value:
                                      type: string
                                      example: "********1234"
                                bic:
                                  type: object
                                  properties:
                                    required:
                                      type: boolean
                                      example: true
                                    label:
                                      type: object
                                      properties:
                                        key:
                                          type: string
                                          example: bank_bic_swift_title
                                    maxlength:
                                      type: integer
                                      example: 70
                                    value:
                                      type: string
                                      example: "********"
                                bank_name:
                                  type: object
                                  properties:
                                    required:
                                      type: boolean
                                      example: true
                                    label:
                                      type: object
                                      properties:
                                        key:
                                          type: string
                                          example: bank_bank_name_title_new
                                    maxlength:
                                      type: integer
                                      example: 70
                                    value:
                                      type: string
                                      example: Bank name
                                country:
                                  type: object
                                  properties:
                                    label:
                                      type: object
                                      properties:
                                        key:
                                          type: string
                                          example: country_label
                                    readonly:
                                      type: boolean
                                      example: true
                                    uionly:
                                      type: boolean
                                      example: true
                                    value:
                                      type: string
                                      example: Country
                                address:
                                  type: object
                                  properties:
                                    required:
                                      type: boolean
                                      example: true
                                    label:
                                      type: object
                                      properties:
                                        key:
                                          type: string
                                          example: bank_user_address_title
                                    maxlength:
                                      type: integer
                                      example: 255
                                    value:
                                      type: string
                                      example: "********"
                                city:
                                  type: object
                                  properties:
                                    required:
                                      type: boolean
                                      example: true
                                    label:
                                      type: object
                                      properties:
                                        key:
                                          type: string
                                          example: bank_user_city_title
                                    maxlength:
                                      type: integer
                                      example: 255
                                    value:
                                      type: string
                                      example: City value
                                postal:
                                  type: object
                                  properties:
                                    required:
                                      type: boolean
                                      example: true
                                    label:
                                      type: object
                                      properties:
                                        key:
                                          type: string
                                          example: bank_user_postal_zip_title
                                    maxlength:
                                      type: integer
                                      example: 255
                                    value:
                                      type: string
                                      example: "********"
                            fieldsOrder:
                              type: array
                              example:
                                - first_name
                                - last_name
                                - iban
                                - bic
                                - bank_name
                                - country
                                - address
                                - city
                                - postal
                              items:
                                type: string
                            uiMapping:
                              type: object
                              properties:
                                title:
                                  type: object
                                  properties:
                                    key:
                                      type: string
                                      example: add_bank_page_title
                                alert:
                                  type: object
                                  properties:
                                    text:
                                      type: object
                                      properties:
                                        key:
                                          type: string
                                          example: payout_add_bank_paxum_hint
                                    class:
                                      type: string
                                      example: info
                                btn_submit:
                                  type: object
                                  properties:
                                    key:
                                      type: string
                                      example: save_payout_details_button
                      payoutCode:
                        type: string
                        example: bank_ebics_sepa
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000000006
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49954
      tags:
        - Banking
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get DAC7 Form Details (/api-reference/banking/get-dac7form-details)

If available, returns the account owner's DAC7 form information required for tax reporting, including personal details, address, tax identification, country information, and DAC7 status.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/banking/details/dac7-form
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/banking/details/dac7-form:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get DAC7 Form Details
      operationId: getDAC7FormDetails
      description: If available, returns the account owner's DAC7 form information
        required for tax reporting, including personal details, address, tax
        identification, country information, and DAC7 status.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    status: success
                    type: personal
                    firstName: FIRST NAME
                    lastName: LAST NAME
                    address: 123 Address
                    city: City
                    state: State
                    zip: "1234"
                    countryId: 123
                    taxId: "1234"
                    issuingCountryId: 123
                    vatNumber: "123"
                    DOB: 2000-01-01
                    cityOfBirth: CityOfBirth
                    countryOfBirthId: 123
                    countryOfResidenceId: 123
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999999
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999996
                      remaining_day: 49947
                properties:
                  data:
                    type: object
                    properties:
                      status:
                        type: string
                        example: success
                      type:
                        type: string
                        example: personal
                      firstName:
                        type: string
                        example: FIRST NAME
                      lastName:
                        type: string
                        example: LAST NAME
                      address:
                        type: string
                        example: 123 Address
                      city:
                        type: string
                        example: City
                      state:
                        type: string
                        example: State
                      zip:
                        type: string
                        example: "1234"
                      countryId:
                        type: integer
                        example: 123
                      taxId:
                        type: string
                        example: "1234"
                      issuingCountryId:
                        type: integer
                        example: 123
                      vatNumber:
                        type: string
                        example: "123"
                      DOB:
                        type: string
                        example: 2000-01-01
                      cityOfBirth:
                        type: string
                        example: CityOfBirth
                      countryOfBirthId:
                        type: integer
                        example: 123
                      countryOfResidenceId:
                        type: integer
                        example: 123
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999999
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999996
                          remaining_day:
                            type: integer
                            example: 49947
      tags:
        - Banking
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Legal and Tax Status (/api-reference/banking/get-legal-and-tax-status)

Returns the account owner's legal and tax status required for banking and payout configuration, including W9 requirements, identity verification status, DAC7 compliance, and tax information.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/banking/details/legal-info
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/banking/details/legal-info:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Legal and Tax Status
      operationId: getLegalAndTaxStatus
      description: Returns the account owner's legal and tax status required for
        banking and payout configuration, including W9 requirements, identity
        verification status, DAC7 compliance, and tax information.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    isXXX: true
                    isW9Required: true
                    isW9Exist: true
                    needShowEditW9: true
                    isRealIdImage: true
                    canChangePayoutType: true
                    ivStatus: approved
                    ivFailReason: null
                    showIvButton: true
                    canShowLegalForm: true
                    payoutLegalApproveRejectReason: null
                    hideBanking: true
                    DAC7:
                      required: true
                      type: personal
                      state: success
                      error: null
                      countryIds:
                        - 123
                    tax:
                      isBankingDisabled: false
                      countryCode: AA
                      editable: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000000004
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49952
                properties:
                  data:
                    type: object
                    properties:
                      isXXX:
                        type: boolean
                        example: true
                      isW9Required:
                        type: boolean
                        example: true
                      isW9Exist:
                        type: boolean
                        example: true
                      needShowEditW9:
                        type: boolean
                        example: true
                      isRealIdImage:
                        type: boolean
                        example: true
                      canChangePayoutType:
                        type: boolean
                        example: true
                      ivStatus:
                        type: string
                        example: approved
                      ivFailReason:
                        type: string
                        example: null
                        nullable: true
                      showIvButton:
                        type: boolean
                        example: true
                      canShowLegalForm:
                        type: boolean
                        example: true
                      payoutLegalApproveRejectReason:
                        type: string
                        example: null
                        nullable: true
                      hideBanking:
                        type: boolean
                        example: true
                      DAC7:
                        type: object
                        properties:
                          required:
                            type: boolean
                            example: true
                          type:
                            type: string
                            example: personal
                          state:
                            type: string
                            example: success
                          error:
                            type: string
                            example: null
                            nullable: true
                          countryIds:
                            type: array
                            example:
                              - 123
                            items:
                              type: integer
                      tax:
                        type: object
                        properties:
                          isBankingDisabled:
                            type: boolean
                            example: false
                          countryCode:
                            type: string
                            example: AA
                          editable:
                            type: boolean
                            example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000000004
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49952
      tags:
        - Banking
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Legal Form Details (/api-reference/banking/get-legal-form-details)

Returns the account owner's legal form details for banking, including personal or business name, address, social media links, date of birth, and available document types for identity verification.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/banking/details/legal-form
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/banking/details/legal-form:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Legal Form Details
      operationId: getLegalFormDetails
      description: Returns the account owner's legal form details for banking,
        including personal or business name, address, social media links, date
        of birth, and available document types for identity verification.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    realFirstName: first name
                    realLastName: last name
                    realBusinessName: business name
                    realAddress: 123 Street Name
                    realCity: city name
                    realState: AA
                    realPostal: "12345"
                    realTwitter: TwitterUsername
                    realInstagram: https://www.instagram.com/instagram
                    privateWebsite: https://example.com
                    dateOfBirth: 2000-01-01T00:00:00+00:00
                    documentType:
                      values:
                        - code: passport
                          name: Passport
                        - code: id_card
                          name: ID Card
                        - code: drivers_license
                          name: Drivers License
                    isAllowedDL: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000000005
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49953
                properties:
                  data:
                    type: object
                    properties:
                      realFirstName:
                        type: string
                        example: first name
                      realLastName:
                        type: string
                        example: last name
                      realBusinessName:
                        type: string
                        example: business name
                      realAddress:
                        type: string
                        example: 123 Street Name
                      realCity:
                        type: string
                        example: city name
                      realState:
                        type: string
                        example: AA
                      realPostal:
                        type: string
                        example: "12345"
                      realTwitter:
                        type: string
                        example: TwitterUsername
                      realInstagram:
                        type: string
                        example: https://www.instagram.com/instagram
                      privateWebsite:
                        type: string
                        example: https://example.com
                      dateOfBirth:
                        type: string
                        example: 2000-01-01T00:00:00+00:00
                      documentType:
                        type: object
                        properties:
                          values:
                            type: array
                            example:
                              - code: passport
                                name: Passport
                              - code: id_card
                                name: ID Card
                              - code: drivers_license
                                name: Drivers License
                            items:
                              type: object
                              properties:
                                code:
                                  type: string
                                  example: passport
                                name:
                                  type: string
                                  example: Passport
                      isAllowedDL:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000000005
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49953
      tags:
        - Banking
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Available Payout Systems (/api-reference/banking/list-available-payout-systems)

Returns a list of available payout systems for the account, including details such as payout method codes, titles, descriptions, minimum payout amounts, processing times, and the currently selected payout method.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/banking/available-payout-systems
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/banking/available-payout-systems:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Available Payout Systems
      operationId: listAvailablePayoutSystems
      description: Returns a list of available payout systems for the account,
        including details such as payout method codes, titles, descriptions,
        minimum payout amounts, processing times, and the currently selected
        payout method.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    payouts:
                      - code: paxum
                        title: Paxum (e-wallet)
                        subtitle: Receive payouts to a Paxum wallet
                        minPayoutSumm: 20
                        payoutTime: 1 business day
                        description: |-
                          No limits on number of daily withdrawals (No maximum)
                          Withdraw money from your Paxum wallet either via bank transfer or on to a Paxum Prepaid Mastercard
                          <a href="https://www.paxum.com/services/receive-payments">click here</a>
                        fields: {}
                        fieldsOrder: []
                        uiMapping: {}
                      - code: cosmopayment
                        title: Cosmo Payment
                        subtitle: Receive payouts directly to your Cosmo Prepaid Mastercard
                        minPayoutSumm: 20
                        payoutTime: 1 Business day
                        description: >-
                          No limits on number of daily withdrawals (No maximum)

                          Withdraw money from your Cosmo Prepaid Mastercard

                          For more information on Cosmo Payment, go to
                          www.cosmopayment.com/getpaid
                        fields: {}
                        fieldsOrder: []
                        uiMapping: {}
                      - code: securionpay
                        title: VISA Direct Transfer
                        subtitle: Receive payouts directly to your VISA debit or credit card
                        minPayoutSumm: 50
                        payoutTime: 1-2 business days
                        description: "Payouts are transferred directly to your VISA Credit or VISA Debit
                          card. "
                        fields: {}
                        fieldsOrder: []
                        uiMapping: {}
                      - code: bank_ebics_sepa
                        title: International Transfer (SEPA)
                        subtitle: Receive payouts directly to your bank account via SEPA payments
                        minPayoutSumm: 20
                        payoutTime: 1-3 business days
                        description: >-
                          No limits on number of daily withdrawals (No maximum)

                          Payouts are paid directly into your bank account via
                          the SEPA banking system

                          Any SEPA bank account
                        fields: {}
                        fieldsOrder: []
                        uiMapping: {}
                      - code: skrill
                        title: Receive your funds via Skrill
                        subtitle: Receive payouts to your Skrill account
                        minPayoutSumm: 20
                        payoutTime: 1 business day
                        description: Receive your funds via Skrill
                        fields: {}
                        fieldsOrder: []
                        uiMapping: {}
                    payoutCode: bank_ebics_sepa
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999996
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49944
                properties:
                  data:
                    type: object
                    properties:
                      payouts:
                        type: array
                        example:
                          - code: paxum
                            title: Paxum (e-wallet)
                            subtitle: Receive payouts to a Paxum wallet
                            minPayoutSumm: 20
                            payoutTime: 1 business day
                            description: |-
                              No limits on number of daily withdrawals (No maximum)
                              Withdraw money from your Paxum wallet either via bank transfer or on to a Paxum Prepaid Mastercard
                              <a href="https://www.paxum.com/services/receive-payments">click here</a>
                            fields: []
                            fieldsOrder: []
                            uiMapping: []
                          - code: cosmopayment
                            title: Cosmo Payment
                            subtitle: Receive payouts directly to your Cosmo Prepaid Mastercard
                            minPayoutSumm: 20
                            payoutTime: 1 Business day
                            description: >-
                              No limits on number of daily withdrawals (No
                              maximum)

                              Withdraw money from your Cosmo Prepaid Mastercard

                              For more information on Cosmo Payment, go to
                              www.cosmopayment.com/getpaid
                            fields: []
                            fieldsOrder: []
                            uiMapping: []
                          - code: securionpay
                            title: VISA Direct Transfer
                            subtitle: Receive payouts directly to your VISA debit or credit card
                            minPayoutSumm: 50
                            payoutTime: 1-2 business days
                            description: "Payouts are transferred directly to your VISA Credit or VISA Debit
                              card. "
                            fields: []
                            fieldsOrder: []
                            uiMapping: []
                          - code: bank_ebics_sepa
                            title: International Transfer (SEPA)
                            subtitle: Receive payouts directly to your bank account via SEPA payments
                            minPayoutSumm: 20
                            payoutTime: 1-3 business days
                            description: >-
                              No limits on number of daily withdrawals (No
                              maximum)

                              Payouts are paid directly into your bank account
                              via the SEPA banking system

                              Any SEPA bank account
                            fields: []
                            fieldsOrder: []
                            uiMapping: []
                          - code: skrill
                            title: Receive your funds via Skrill
                            subtitle: Receive payouts to your Skrill account
                            minPayoutSumm: 20
                            payoutTime: 1 business day
                            description: Receive your funds via Skrill
                            fields: []
                            fieldsOrder: []
                            uiMapping: []
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                              example: paxum
                            title:
                              type: string
                              example: Paxum (e-wallet)
                            subtitle:
                              type: string
                              example: Receive payouts to a Paxum wallet
                            minPayoutSumm:
                              type: integer
                              example: 20
                            payoutTime:
                              type: string
                              example: 1 business day
                            description:
                              type: string
                              example: |-
                                No limits on number of daily withdrawals (No maximum)
                                Withdraw money from your Paxum wallet either via bank transfer or on to a Paxum Prepaid Mastercard
                                <a href="https://www.paxum.com/services/receive-payments">click here</a>
                            fields:
                              type: object
                              properties: {}
                            fieldsOrder:
                              type: array
                              example: []
                            uiMapping:
                              type: object
                              properties: {}
                      payoutCode:
                        type: string
                        example: bank_ebics_sepa
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999996
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49944
      tags:
        - Banking
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Countries (/api-reference/banking/list-countries)

List countries, their internal OnlyFans IDs, and their payment & tax information.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/banking/countries
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/banking/countries:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Countries
      operationId: listCountries
      description: List countries, their internal OnlyFans IDs, and their payment &
        tax information.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - id: 212
                      code: US
                      name: United States of America
                      hasStates: true
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 211
                      code: GB
                      name: United Kingdom
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 1
                      code: AF
                      name: Afghanistan
                      hasStates: false
                      hasZip: true
                      canPay: false
                      canHasW9Form: false
                    - id: 2
                      code: AL
                      name: Albania
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 3
                      code: DZ
                      name: Algeria
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 4
                      code: AS
                      name: American Samoa
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 5
                      code: AD
                      name: Andorra
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 6
                      code: AO
                      name: Angola
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 7
                      code: AI
                      name: Anguilla
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 8
                      code: AG
                      name: Antigua and Barbuda
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 9
                      code: AR
                      name: Argentina
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 10
                      code: AM
                      name: Armenia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 11
                      code: AW
                      name: Aruba
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 12
                      code: AU
                      name: Australia
                      hasStates: true
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 13
                      code: AT
                      name: Austria
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 14
                      code: AZ
                      name: Azerbaijan
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 15
                      code: BS
                      name: Bahamas
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 16
                      code: BH
                      name: Bahrain
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 17
                      code: BD
                      name: Bangladesh
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 18
                      code: BB
                      name: Barbados
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 19
                      code: BY
                      name: Belarus
                      hasStates: false
                      hasZip: true
                      canPay: false
                      canHasW9Form: false
                    - id: 20
                      code: BE
                      name: Belgium
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 21
                      code: BZ
                      name: Belize
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 22
                      code: BJ
                      name: Benin
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 23
                      code: BM
                      name: Bermuda
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 24
                      code: BT
                      name: Bhutan
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 25
                      code: BO
                      name: Bolivia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 26
                      code: BA
                      name: Bosnia and Herzegovina
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 27
                      code: BW
                      name: Botswana
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 28
                      code: BR
                      name: Brazil
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 29
                      code: VG
                      name: British Virgin Islands
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 30
                      code: BN
                      name: Brunei
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 31
                      code: BG
                      name: Bulgaria
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 32
                      code: BF
                      name: Burkina Faso
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 33
                      code: BI
                      name: Burundi
                      hasStates: false
                      hasZip: false
                      canPay: false
                      canHasW9Form: false
                    - id: 34
                      code: KH
                      name: Cambodia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 35
                      code: CM
                      name: Cameroon
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 36
                      code: CA
                      name: Canada
                      hasStates: true
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 37
                      code: CV
                      name: Cape Verde
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 38
                      code: KY
                      name: Cayman Islands
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 39
                      code: CF
                      name: Central African Republic
                      hasStates: false
                      hasZip: false
                      canPay: false
                      canHasW9Form: false
                    - id: 40
                      code: TD
                      name: Chad
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 41
                      code: CL
                      name: Chile
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 42
                      code: CN
                      name: China
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 43
                      code: CX
                      name: Christmas Island
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 44
                      code: CO
                      name: Colombia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 45
                      code: KM
                      name: Comoros
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 46
                      code: CK
                      name: Cook Islands
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 47
                      code: CR
                      name: Costa Rica
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 48
                      code: CI
                      name: Côte d'Ivoire
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 49
                      code: HR
                      name: Croatia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 50
                      code: CU
                      name: Cuba
                      hasStates: false
                      hasZip: true
                      canPay: false
                      canHasW9Form: false
                    - id: 51
                      code: CY
                      name: Cyprus
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 52
                      code: CZ
                      name: Czech Republic
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 53
                      code: CD
                      name: Democratic Republic of the Congo
                      hasStates: false
                      hasZip: false
                      canPay: false
                      canHasW9Form: false
                    - id: 54
                      code: DK
                      name: Denmark
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 55
                      code: DJ
                      name: Djibouti
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 57
                      code: DM
                      name: Dominica
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 56
                      code: DO
                      name: Dominican Republic
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 58
                      code: EC
                      name: Ecuador
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 59
                      code: EG
                      name: Egypt
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 60
                      code: SV
                      name: El Salvador
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 61
                      code: GQ
                      name: Equatorial Guinea
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 62
                      code: ER
                      name: Eritrea
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 63
                      code: EE
                      name: Estonia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 64
                      code: ET
                      name: Ethiopia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 65
                      code: FK
                      name: Falkland Islands
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 66
                      code: FO
                      name: Faroe Islands
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 67
                      code: FJ
                      name: Fiji
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 68
                      code: FI
                      name: Finland
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 69
                      code: FR
                      name: France
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 70
                      code: PF
                      name: French Polynesia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 71
                      code: GA
                      name: Gabon
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 72
                      code: GM
                      name: Gambia
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 73
                      code: GE
                      name: Georgia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 74
                      code: DE
                      name: Germany
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 75
                      code: GH
                      name: Ghana
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 76
                      code: GI
                      name: Gibraltar
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 77
                      code: GR
                      name: Greece
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 78
                      code: GL
                      name: Greenland
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 79
                      code: GD
                      name: Grenada
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 80
                      code: GU
                      name: Guam
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 81
                      code: GT
                      name: Guatemala
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 227
                      code: GG
                      name: Guernsey
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 83
                      code: GN
                      name: Guinea
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 82
                      code: GW
                      name: Guinea Bissau
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 84
                      code: GY
                      name: Guyana
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 85
                      code: HT
                      name: Haiti
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 86
                      code: HN
                      name: Honduras
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 87
                      code: HK
                      name: Hong Kong
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 88
                      code: HU
                      name: Hungary
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 89
                      code: IS
                      name: Iceland
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 90
                      code: IN
                      name: India
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 91
                      code: ID
                      name: Indonesia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 92
                      code: IR
                      name: Iran
                      hasStates: false
                      hasZip: true
                      canPay: false
                      canHasW9Form: false
                    - id: 93
                      code: IQ
                      name: Iraq
                      hasStates: false
                      hasZip: true
                      canPay: false
                      canHasW9Form: false
                    - id: 94
                      code: IE
                      name: Ireland
                      hasStates: true
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 228
                      code: IM
                      name: Isle of Man
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 95
                      code: IL
                      name: Israel
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 96
                      code: IT
                      name: Italy
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 97
                      code: JM
                      name: Jamaica
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 98
                      code: JP
                      name: Japan
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 225
                      code: JE
                      name: Jersey
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 99
                      code: JO
                      name: Jordan
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 100
                      code: KZ
                      name: Kazakhstan
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 101
                      code: KE
                      name: Kenya
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 102
                      code: KI
                      name: Kiribati
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 226
                      code: XK
                      name: Kosovo
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 103
                      code: KW
                      name: Kuwait
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 104
                      code: KG
                      name: Kyrgyzstan
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 105
                      code: LA
                      name: Laos
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 106
                      code: LV
                      name: Latvia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 107
                      code: LB
                      name: Lebanon
                      hasStates: false
                      hasZip: true
                      canPay: false
                      canHasW9Form: false
                    - id: 108
                      code: LS
                      name: Lesotho
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 109
                      code: LR
                      name: Liberia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 110
                      code: LY
                      name: Libya
                      hasStates: false
                      hasZip: true
                      canPay: false
                      canHasW9Form: false
                    - id: 111
                      code: LI
                      name: Liechtenstein
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 112
                      code: LT
                      name: Lithuania
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 113
                      code: LU
                      name: Luxembourg
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 114
                      code: MO
                      name: Macao
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 115
                      code: MK
                      name: Macedonia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 116
                      code: MG
                      name: Madagascar
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 117
                      code: MW
                      name: Malawi
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 118
                      code: MY
                      name: Malaysia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 119
                      code: MV
                      name: Maldives
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 120
                      code: ML
                      name: Mali
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 121
                      code: MT
                      name: Malta
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 122
                      code: MH
                      name: Marshall Islands
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 123
                      code: MQ
                      name: Martinique
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 124
                      code: MR
                      name: Mauritania
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 125
                      code: MU
                      name: Mauritius
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 126
                      code: MX
                      name: Mexico
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 127
                      code: FM
                      name: Micronesia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 128
                      code: MD
                      name: Moldova
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 129
                      code: MC
                      name: Monaco
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 130
                      code: MN
                      name: Mongolia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 224
                      code: ME
                      name: Montenegro
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 131
                      code: MS
                      name: Montserrat
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 132
                      code: MA
                      name: Morocco
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 133
                      code: MZ
                      name: Mozambique
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 134
                      code: MM
                      name: Myanmar
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 135
                      code: NA
                      name: Namibia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 136
                      code: NR
                      name: Nauru
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 137
                      code: NP
                      name: Nepal
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 139
                      code: NL
                      name: Netherlands
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 138
                      code: AN
                      name: Netherlands Antilles
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 140
                      code: NZ
                      name: New Zealand
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 141
                      code: NI
                      name: Nicaragua
                      hasStates: false
                      hasZip: true
                      canPay: false
                      canHasW9Form: false
                    - id: 143
                      code: NE
                      name: Niger
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 142
                      code: NG
                      name: Nigeria
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 144
                      code: NU
                      name: Niue
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 145
                      code: NF
                      name: Norfolk Island
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 146
                      code: KP
                      name: North Korea
                      hasStates: false
                      hasZip: false
                      canPay: false
                      canHasW9Form: false
                    - id: 147
                      code: NO
                      name: Norway
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 148
                      code: OM
                      name: Oman
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 149
                      code: PK
                      name: Pakistan
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 150
                      code: PW
                      name: Palau
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 151
                      code: PA
                      name: Panama
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 152
                      code: PG
                      name: Papua New Guinea
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 153
                      code: PY
                      name: Paraguay
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 154
                      code: PE
                      name: Peru
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 155
                      code: PH
                      name: Philippines
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 156
                      code: PN
                      name: Pitcairn Islands
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 157
                      code: PL
                      name: Poland
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 158
                      code: PT
                      name: Portugal
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 159
                      code: PR
                      name: Puerto Rico
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 160
                      code: QA
                      name: Qatar
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 161
                      code: CG
                      name: Republic of the Congo
                      hasStates: false
                      hasZip: false
                      canPay: false
                      canHasW9Form: false
                    - id: 162
                      code: RO
                      name: Romania
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 163
                      code: RU
                      name: Russian Federation
                      hasStates: false
                      hasZip: true
                      canPay: false
                      canHasW9Form: false
                    - id: 164
                      code: RW
                      name: Rwanda
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 165
                      code: KN
                      name: Saint Kitts and Nevis
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 166
                      code: LC
                      name: Saint Lucia
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 167
                      code: PM
                      name: Saint Pierre
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 168
                      code: VC
                      name: Saint Vincent and the Grenadines
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 169
                      code: WS
                      name: Samoa
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 170
                      code: SM
                      name: San Marino
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 171
                      code: ST
                      name: Sao Tomé and Príncipe
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 172
                      code: SA
                      name: Saudi Arabia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 173
                      code: SN
                      name: Senegal
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 174
                      code: RS
                      name: Serbia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 175
                      code: SC
                      name: Seychelles
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 176
                      code: SL
                      name: Sierra Leone
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 177
                      code: SG
                      name: Singapore
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 178
                      code: SK
                      name: Slovakia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 179
                      code: SI
                      name: Slovenia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 180
                      code: SB
                      name: Solomon Islands
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 181
                      code: SO
                      name: Somalia
                      hasStates: false
                      hasZip: false
                      canPay: false
                      canHasW9Form: false
                    - id: 182
                      code: ZA
                      name: South Africa
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 183
                      code: GS
                      name: South Georgia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 184
                      code: KR
                      name: South Korea
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 186
                      code: ES
                      name: Spain
                      hasStates: true
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 187
                      code: LK
                      name: Sri Lanka
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 188
                      code: SD
                      name: Sudan
                      hasStates: false
                      hasZip: true
                      canPay: false
                      canHasW9Form: false
                    - id: 189
                      code: SR
                      name: Suriname
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 190
                      code: SZ
                      name: Swaziland
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 191
                      code: SE
                      name: Sweden
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 192
                      code: CH
                      name: Switzerland
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 193
                      code: SY
                      name: Syria
                      hasStates: false
                      hasZip: false
                      canPay: false
                      canHasW9Form: false
                    - id: 194
                      code: TW
                      name: Taiwan
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 195
                      code: TJ
                      name: Tajikistan
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 196
                      code: TZ
                      name: Tanzania
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 197
                      code: TH
                      name: Thailand
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 198
                      code: TB
                      name: Tibet
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 199
                      code: TL
                      name: Timor-Leste
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 200
                      code: TG
                      name: Togo
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 201
                      code: TO
                      name: Tonga
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 202
                      code: TT
                      name: Trinidad and Tobago
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 203
                      code: TN
                      name: Tunisia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 204
                      code: TR
                      name: Turkey
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 205
                      code: TM
                      name: Turkmenistan
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 206
                      code: TC
                      name: Turks and Caicos Islands
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 207
                      code: TV
                      name: Tuvalu
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 208
                      code: AE
                      name: UAE
                      hasStates: true
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 209
                      code: UG
                      name: Uganda
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 210
                      code: UA
                      name: Ukraine
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 213
                      code: UY
                      name: Uruguay
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 214
                      code: VI
                      name: US Virgin Islands
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 215
                      code: UZ
                      name: Uzbekistan
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 216
                      code: VU
                      name: Vanuatu
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    - id: 217
                      code: VA
                      name: Vatican City
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 218
                      code: VE
                      name: Venezuela
                      hasStates: false
                      hasZip: true
                      canPay: false
                      canHasW9Form: false
                    - id: 219
                      code: VN
                      name: Vietnam
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 220
                      code: WF
                      name: Wallis and Futuna
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 221
                      code: YE
                      name: Yemen
                      hasStates: false
                      hasZip: false
                      canPay: false
                      canHasW9Form: false
                    - id: 222
                      code: ZM
                      name: Zambia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    - id: 223
                      code: ZW
                      name: Zimbabwe
                      hasStates: false
                      hasZip: false
                      canPay: false
                      canHasW9Form: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999997
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49945
                properties:
                  data:
                    type: array
                    example:
                      - id: 212
                        code: US
                        name: United States of America
                        hasStates: true
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 211
                        code: GB
                        name: United Kingdom
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 1
                        code: AF
                        name: Afghanistan
                        hasStates: false
                        hasZip: true
                        canPay: false
                        canHasW9Form: false
                      - id: 2
                        code: AL
                        name: Albania
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 3
                        code: DZ
                        name: Algeria
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 4
                        code: AS
                        name: American Samoa
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 5
                        code: AD
                        name: Andorra
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 6
                        code: AO
                        name: Angola
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 7
                        code: AI
                        name: Anguilla
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 8
                        code: AG
                        name: Antigua and Barbuda
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 9
                        code: AR
                        name: Argentina
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 10
                        code: AM
                        name: Armenia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 11
                        code: AW
                        name: Aruba
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 12
                        code: AU
                        name: Australia
                        hasStates: true
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 13
                        code: AT
                        name: Austria
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 14
                        code: AZ
                        name: Azerbaijan
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 15
                        code: BS
                        name: Bahamas
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 16
                        code: BH
                        name: Bahrain
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 17
                        code: BD
                        name: Bangladesh
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 18
                        code: BB
                        name: Barbados
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 19
                        code: BY
                        name: Belarus
                        hasStates: false
                        hasZip: true
                        canPay: false
                        canHasW9Form: false
                      - id: 20
                        code: BE
                        name: Belgium
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 21
                        code: BZ
                        name: Belize
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 22
                        code: BJ
                        name: Benin
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 23
                        code: BM
                        name: Bermuda
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 24
                        code: BT
                        name: Bhutan
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 25
                        code: BO
                        name: Bolivia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 26
                        code: BA
                        name: Bosnia and Herzegovina
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 27
                        code: BW
                        name: Botswana
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 28
                        code: BR
                        name: Brazil
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 29
                        code: VG
                        name: British Virgin Islands
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 30
                        code: BN
                        name: Brunei
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 31
                        code: BG
                        name: Bulgaria
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 32
                        code: BF
                        name: Burkina Faso
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 33
                        code: BI
                        name: Burundi
                        hasStates: false
                        hasZip: false
                        canPay: false
                        canHasW9Form: false
                      - id: 34
                        code: KH
                        name: Cambodia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 35
                        code: CM
                        name: Cameroon
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 36
                        code: CA
                        name: Canada
                        hasStates: true
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 37
                        code: CV
                        name: Cape Verde
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 38
                        code: KY
                        name: Cayman Islands
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 39
                        code: CF
                        name: Central African Republic
                        hasStates: false
                        hasZip: false
                        canPay: false
                        canHasW9Form: false
                      - id: 40
                        code: TD
                        name: Chad
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 41
                        code: CL
                        name: Chile
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 42
                        code: CN
                        name: China
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 43
                        code: CX
                        name: Christmas Island
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 44
                        code: CO
                        name: Colombia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 45
                        code: KM
                        name: Comoros
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 46
                        code: CK
                        name: Cook Islands
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 47
                        code: CR
                        name: Costa Rica
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 48
                        code: CI
                        name: Côte d'Ivoire
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 49
                        code: HR
                        name: Croatia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 50
                        code: CU
                        name: Cuba
                        hasStates: false
                        hasZip: true
                        canPay: false
                        canHasW9Form: false
                      - id: 51
                        code: CY
                        name: Cyprus
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 52
                        code: CZ
                        name: Czech Republic
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 53
                        code: CD
                        name: Democratic Republic of the Congo
                        hasStates: false
                        hasZip: false
                        canPay: false
                        canHasW9Form: false
                      - id: 54
                        code: DK
                        name: Denmark
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 55
                        code: DJ
                        name: Djibouti
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 57
                        code: DM
                        name: Dominica
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 56
                        code: DO
                        name: Dominican Republic
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 58
                        code: EC
                        name: Ecuador
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 59
                        code: EG
                        name: Egypt
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 60
                        code: SV
                        name: El Salvador
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 61
                        code: GQ
                        name: Equatorial Guinea
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 62
                        code: ER
                        name: Eritrea
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 63
                        code: EE
                        name: Estonia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 64
                        code: ET
                        name: Ethiopia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 65
                        code: FK
                        name: Falkland Islands
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 66
                        code: FO
                        name: Faroe Islands
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 67
                        code: FJ
                        name: Fiji
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 68
                        code: FI
                        name: Finland
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 69
                        code: FR
                        name: France
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 70
                        code: PF
                        name: French Polynesia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 71
                        code: GA
                        name: Gabon
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 72
                        code: GM
                        name: Gambia
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 73
                        code: GE
                        name: Georgia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 74
                        code: DE
                        name: Germany
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 75
                        code: GH
                        name: Ghana
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 76
                        code: GI
                        name: Gibraltar
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 77
                        code: GR
                        name: Greece
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 78
                        code: GL
                        name: Greenland
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 79
                        code: GD
                        name: Grenada
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 80
                        code: GU
                        name: Guam
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 81
                        code: GT
                        name: Guatemala
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 227
                        code: GG
                        name: Guernsey
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 83
                        code: GN
                        name: Guinea
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 82
                        code: GW
                        name: Guinea Bissau
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 84
                        code: GY
                        name: Guyana
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 85
                        code: HT
                        name: Haiti
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 86
                        code: HN
                        name: Honduras
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 87
                        code: HK
                        name: Hong Kong
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 88
                        code: HU
                        name: Hungary
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 89
                        code: IS
                        name: Iceland
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 90
                        code: IN
                        name: India
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 91
                        code: ID
                        name: Indonesia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 92
                        code: IR
                        name: Iran
                        hasStates: false
                        hasZip: true
                        canPay: false
                        canHasW9Form: false
                      - id: 93
                        code: IQ
                        name: Iraq
                        hasStates: false
                        hasZip: true
                        canPay: false
                        canHasW9Form: false
                      - id: 94
                        code: IE
                        name: Ireland
                        hasStates: true
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 228
                        code: IM
                        name: Isle of Man
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 95
                        code: IL
                        name: Israel
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 96
                        code: IT
                        name: Italy
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 97
                        code: JM
                        name: Jamaica
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 98
                        code: JP
                        name: Japan
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 225
                        code: JE
                        name: Jersey
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 99
                        code: JO
                        name: Jordan
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 100
                        code: KZ
                        name: Kazakhstan
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 101
                        code: KE
                        name: Kenya
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 102
                        code: KI
                        name: Kiribati
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 226
                        code: XK
                        name: Kosovo
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 103
                        code: KW
                        name: Kuwait
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 104
                        code: KG
                        name: Kyrgyzstan
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 105
                        code: LA
                        name: Laos
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 106
                        code: LV
                        name: Latvia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 107
                        code: LB
                        name: Lebanon
                        hasStates: false
                        hasZip: true
                        canPay: false
                        canHasW9Form: false
                      - id: 108
                        code: LS
                        name: Lesotho
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 109
                        code: LR
                        name: Liberia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 110
                        code: LY
                        name: Libya
                        hasStates: false
                        hasZip: true
                        canPay: false
                        canHasW9Form: false
                      - id: 111
                        code: LI
                        name: Liechtenstein
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 112
                        code: LT
                        name: Lithuania
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 113
                        code: LU
                        name: Luxembourg
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 114
                        code: MO
                        name: Macao
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 115
                        code: MK
                        name: Macedonia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 116
                        code: MG
                        name: Madagascar
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 117
                        code: MW
                        name: Malawi
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 118
                        code: MY
                        name: Malaysia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 119
                        code: MV
                        name: Maldives
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 120
                        code: ML
                        name: Mali
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 121
                        code: MT
                        name: Malta
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 122
                        code: MH
                        name: Marshall Islands
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 123
                        code: MQ
                        name: Martinique
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 124
                        code: MR
                        name: Mauritania
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 125
                        code: MU
                        name: Mauritius
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 126
                        code: MX
                        name: Mexico
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 127
                        code: FM
                        name: Micronesia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 128
                        code: MD
                        name: Moldova
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 129
                        code: MC
                        name: Monaco
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 130
                        code: MN
                        name: Mongolia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 224
                        code: ME
                        name: Montenegro
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 131
                        code: MS
                        name: Montserrat
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 132
                        code: MA
                        name: Morocco
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 133
                        code: MZ
                        name: Mozambique
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 134
                        code: MM
                        name: Myanmar
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 135
                        code: NA
                        name: Namibia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 136
                        code: NR
                        name: Nauru
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 137
                        code: NP
                        name: Nepal
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 139
                        code: NL
                        name: Netherlands
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 138
                        code: AN
                        name: Netherlands Antilles
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 140
                        code: NZ
                        name: New Zealand
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 141
                        code: NI
                        name: Nicaragua
                        hasStates: false
                        hasZip: true
                        canPay: false
                        canHasW9Form: false
                      - id: 143
                        code: NE
                        name: Niger
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 142
                        code: NG
                        name: Nigeria
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 144
                        code: NU
                        name: Niue
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 145
                        code: NF
                        name: Norfolk Island
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 146
                        code: KP
                        name: North Korea
                        hasStates: false
                        hasZip: false
                        canPay: false
                        canHasW9Form: false
                      - id: 147
                        code: NO
                        name: Norway
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 148
                        code: OM
                        name: Oman
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 149
                        code: PK
                        name: Pakistan
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 150
                        code: PW
                        name: Palau
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 151
                        code: PA
                        name: Panama
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 152
                        code: PG
                        name: Papua New Guinea
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 153
                        code: PY
                        name: Paraguay
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 154
                        code: PE
                        name: Peru
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 155
                        code: PH
                        name: Philippines
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 156
                        code: PN
                        name: Pitcairn Islands
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 157
                        code: PL
                        name: Poland
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 158
                        code: PT
                        name: Portugal
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 159
                        code: PR
                        name: Puerto Rico
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 160
                        code: QA
                        name: Qatar
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 161
                        code: CG
                        name: Republic of the Congo
                        hasStates: false
                        hasZip: false
                        canPay: false
                        canHasW9Form: false
                      - id: 162
                        code: RO
                        name: Romania
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 163
                        code: RU
                        name: Russian Federation
                        hasStates: false
                        hasZip: true
                        canPay: false
                        canHasW9Form: false
                      - id: 164
                        code: RW
                        name: Rwanda
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 165
                        code: KN
                        name: Saint Kitts and Nevis
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 166
                        code: LC
                        name: Saint Lucia
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 167
                        code: PM
                        name: Saint Pierre
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 168
                        code: VC
                        name: Saint Vincent and the Grenadines
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 169
                        code: WS
                        name: Samoa
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 170
                        code: SM
                        name: San Marino
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 171
                        code: ST
                        name: Sao Tomé and Príncipe
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 172
                        code: SA
                        name: Saudi Arabia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 173
                        code: SN
                        name: Senegal
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 174
                        code: RS
                        name: Serbia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 175
                        code: SC
                        name: Seychelles
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 176
                        code: SL
                        name: Sierra Leone
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 177
                        code: SG
                        name: Singapore
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 178
                        code: SK
                        name: Slovakia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 179
                        code: SI
                        name: Slovenia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 180
                        code: SB
                        name: Solomon Islands
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 181
                        code: SO
                        name: Somalia
                        hasStates: false
                        hasZip: false
                        canPay: false
                        canHasW9Form: false
                      - id: 182
                        code: ZA
                        name: South Africa
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 183
                        code: GS
                        name: South Georgia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 184
                        code: KR
                        name: South Korea
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 186
                        code: ES
                        name: Spain
                        hasStates: true
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 187
                        code: LK
                        name: Sri Lanka
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 188
                        code: SD
                        name: Sudan
                        hasStates: false
                        hasZip: true
                        canPay: false
                        canHasW9Form: false
                      - id: 189
                        code: SR
                        name: Suriname
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 190
                        code: SZ
                        name: Swaziland
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 191
                        code: SE
                        name: Sweden
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 192
                        code: CH
                        name: Switzerland
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 193
                        code: SY
                        name: Syria
                        hasStates: false
                        hasZip: false
                        canPay: false
                        canHasW9Form: false
                      - id: 194
                        code: TW
                        name: Taiwan
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 195
                        code: TJ
                        name: Tajikistan
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 196
                        code: TZ
                        name: Tanzania
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 197
                        code: TH
                        name: Thailand
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 198
                        code: TB
                        name: Tibet
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 199
                        code: TL
                        name: Timor-Leste
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 200
                        code: TG
                        name: Togo
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 201
                        code: TO
                        name: Tonga
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 202
                        code: TT
                        name: Trinidad and Tobago
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 203
                        code: TN
                        name: Tunisia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 204
                        code: TR
                        name: Turkey
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 205
                        code: TM
                        name: Turkmenistan
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 206
                        code: TC
                        name: Turks and Caicos Islands
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 207
                        code: TV
                        name: Tuvalu
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 208
                        code: AE
                        name: UAE
                        hasStates: true
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 209
                        code: UG
                        name: Uganda
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 210
                        code: UA
                        name: Ukraine
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 213
                        code: UY
                        name: Uruguay
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 214
                        code: VI
                        name: US Virgin Islands
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 215
                        code: UZ
                        name: Uzbekistan
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 216
                        code: VU
                        name: Vanuatu
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      - id: 217
                        code: VA
                        name: Vatican City
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 218
                        code: VE
                        name: Venezuela
                        hasStates: false
                        hasZip: true
                        canPay: false
                        canHasW9Form: false
                      - id: 219
                        code: VN
                        name: Vietnam
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 220
                        code: WF
                        name: Wallis and Futuna
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 221
                        code: YE
                        name: Yemen
                        hasStates: false
                        hasZip: false
                        canPay: false
                        canHasW9Form: false
                      - id: 222
                        code: ZM
                        name: Zambia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      - id: 223
                        code: ZW
                        name: Zimbabwe
                        hasStates: false
                        hasZip: false
                        canPay: false
                        canHasW9Form: false
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 212
                        code:
                          type: string
                          example: US
                        name:
                          type: string
                          example: United States of America
                        hasStates:
                          type: boolean
                          example: true
                        hasZip:
                          type: boolean
                          example: true
                        canPay:
                          type: boolean
                          example: true
                        canHasW9Form:
                          type: boolean
                          example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999997
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49945
      tags:
        - Banking
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Calculate Chargeback Ratio (/api-reference/chargebacks/calculate-chargeback-ratio)

The Chargeback Ratio reflects the number of chargebacks compared to the total number of payments as a percentage. Ideally, your Chargeback Ratio should be under 1%.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/chargebacks/ratio
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/chargebacks/ratio:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Calculate Chargeback Ratio
      operationId: calculateChargebackRatio
      description: The Chargeback Ratio reflects the number of chargebacks compared to
        the total number of payments as a percentage. Ideally, your Chargeback
        Ratio should be under 1%.
      parameters:
        - in: query
          name: start_date
          description: The start date for the chargeback ratio. Keep empty to get all.
          example: 2025-01-01 00:00:00
          required: false
          schema:
            type: string
            description: The start date for the chargeback ratio. Keep empty to get all.
            example: 2025-01-01 00:00:00
        - in: query
          name: end_date
          description: The end date for the chargeback ratio. Keep empty to get all.
          example: 2025-03-31 23:59:59
          required: false
          schema:
            type: string
            description: The end date for the chargeback ratio. Keep empty to get all.
            example: 2025-03-31 23:59:59
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    chargebacksRatio: 0.08
                  _meta:
                    _credits:
                      used: 1
                      balance: 999964320
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49992
                properties:
                  data:
                    type: object
                    properties:
                      chargebacksRatio:
                        type: number
                        example: 0.08
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999964320
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49992
      tags:
        - Chargebacks
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Chargeback Statistics (/api-reference/chargebacks/list-chargeback-statistics)

List chargeback counts & amounts per hour, day or month.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/chargebacks/statistics
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/chargebacks/statistics:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Chargeback Statistics
      operationId: listChargebackStatistics
      description: List chargeback counts & amounts per hour, day or month.
      parameters:
        - in: query
          name: start_date
          description: The start date for the chargebacks. Keep empty to get all.
          example: 2025-01-01 00:00:00
          required: false
          schema:
            type: string
            description: The start date for the chargebacks. Keep empty to get all.
            example: 2025-01-01 00:00:00
        - in: query
          name: end_date
          description: The end date for the chargebacks. Keep empty to get all.
          example: 2025-03-31 23:59:59
          required: false
          schema:
            type: string
            description: The end date for the chargebacks. Keep empty to get all.
            example: 2025-03-31 23:59:59
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    chartAmount:
                      - date: 2025-01-01T00:00:00+00:00
                        count: 123.45
                    chartCount:
                      - date: 2025-01-01T00:00:00+00:00
                        count: 123
                    total: 123.45
                    delta: 100
                  _meta:
                    _credits:
                      used: 1
                      balance: 999964316
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 996
                      remaining_day: 49988
                properties:
                  data:
                    type: object
                    properties:
                      chartAmount:
                        type: array
                        example:
                          - date: 2025-01-01T00:00:00+00:00
                            count: 123.45
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            count:
                              type: number
                              example: 123.45
                      chartCount:
                        type: array
                        example:
                          - date: 2025-01-01T00:00:00+00:00
                            count: 123
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            count:
                              type: integer
                              example: 123
                      total:
                        type: number
                        example: 123.45
                      delta:
                        type: integer
                        example: 100
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999964316
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 996
                          remaining_day:
                            type: integer
                            example: 49988
      tags:
        - Chargebacks
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Chargebacks (/api-reference/chargebacks/list-chargebacks)

Retrieve a list of chargebacks within a specified date range. Possible statuses are `loading`, `done`, `undo`.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/chargebacks
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/chargebacks:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Chargebacks
      operationId: listChargebacks
      description: Retrieve a list of chargebacks within a specified date range.
        Possible statuses are `loading`, `done`, `undo`.
      parameters:
        - in: query
          name: start_date
          description: The start date for the chargebacks. Keep empty to get all.
          example: 2025-01-01 00:00:00
          required: false
          schema:
            type: string
            description: The start date for the chargebacks. Keep empty to get all.
            example: 2025-01-01 00:00:00
        - in: query
          name: end_date
          description: The end date for the chargebacks. Keep empty to get all.
          example: 2025-03-31 23:59:59
          required: false
          schema:
            type: string
            description: The end date for the chargebacks. Keep empty to get all.
            example: 2025-03-31 23:59:59
        - in: query
          name: limit
          description: Number of chargebacks to return (1-100). Default = 10
          example: 50
          required: false
          schema:
            type: string
            description: Number of chargebacks to return (1-100). Default = 10
            example: 50
            nullable: true
        - in: query
          name: offset
          description: Number of chargebacks to skip, used for pagination.
          example: 0
          required: false
          schema:
            type: string
            description: Number of chargebacks to skip, used for pagination.
            example: 0
            nullable: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - id: 0
                        createdAt: 2025-01-01T00:00:00+00:00
                        paymentType: tips
                        payment:
                          amount: 12.34
                          vatAmount: 0
                          taxAmount: 0
                          mediaTaxAmount: 0
                          net: 12.34
                          fee: 5
                          createdAt: 2025-01-01T00:00:00+00:00
                          currency: USD
                          description: Tip from <a href="https://onlyfans.com/username">Name</a>
                          status: undo
                          user:
                            view: t
                            id: 123
                            name: Name
                            username: username
                            isVerified: false
                            avatar: null
                            avatarThumbs: null
                          payoutPendingDays: 7
                          id: abc123
                    marker: 123
                  _meta:
                    _credits:
                      used: 1
                      balance: 999964322
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49994
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - id: 0
                            createdAt: 2025-01-01T00:00:00+00:00
                            paymentType: tips
                            payment:
                              amount: 12.34
                              vatAmount: 0
                              taxAmount: 0
                              mediaTaxAmount: 0
                              net: 12.34
                              fee: 5
                              createdAt: 2025-01-01T00:00:00+00:00
                              currency: USD
                              description: Tip from <a href="https://onlyfans.com/username">Name</a>
                              status: undo
                              user:
                                view: t
                                id: 123
                                name: Name
                                username: username
                                isVerified: false
                                avatar: null
                                avatarThumbs: null
                              payoutPendingDays: 7
                              id: abc123
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 0
                            createdAt:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            paymentType:
                              type: string
                              example: tips
                            payment:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 12.34
                                vatAmount:
                                  type: integer
                                  example: 0
                                taxAmount:
                                  type: integer
                                  example: 0
                                mediaTaxAmount:
                                  type: integer
                                  example: 0
                                net:
                                  type: number
                                  example: 12.34
                                fee:
                                  type: integer
                                  example: 5
                                createdAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                currency:
                                  type: string
                                  example: USD
                                description:
                                  type: string
                                  example: Tip from <a href="https://onlyfans.com/username">Name</a>
                                status:
                                  type: string
                                  example: undo
                                user:
                                  type: object
                                  properties:
                                    view:
                                      type: string
                                      example: t
                                    id:
                                      type: integer
                                      example: 123
                                    name:
                                      type: string
                                      example: Name
                                    username:
                                      type: string
                                      example: username
                                    isVerified:
                                      type: boolean
                                      example: false
                                    avatar:
                                      type: string
                                      example: null
                                      nullable: true
                                    avatarThumbs:
                                      type: string
                                      example: null
                                      nullable: true
                                payoutPendingDays:
                                  type: integer
                                  example: 7
                                id:
                                  type: string
                                  example: abc123
                      marker:
                        type: integer
                        example: 123
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999964322
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49994
      tags:
        - Chargebacks
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Blocked Users (/api-reference/blocked-restricted-users/list-blocked-users)

Get a paginated list of users the account has blocked. Optionally search with `query`.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/users/blocked
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/users/blocked:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Blocked Users
      operationId: listBlockedUsers
      description: Get a paginated list of users the account has blocked. Optionally
        search with `query`.
      parameters:
        - in: query
          name: limit
          description: Number of users to return per page (1-50). Must be at least 1. Must
            not be greater than 50.
          example: 10
          required: false
          schema:
            type: integer
            description: Number of users to return per page (1-50). Must be at least 1. Must
              not be greater than 50.
            example: 10
        - in: query
          name: offset
          description: Number of users to skip for pagination. Must be at least 0.
          example: 0
          required: false
          schema:
            type: integer
            description: Number of users to skip for pagination. Must be at least 0.
            example: 0
        - in: query
          name: query
          description: Search within the user name or username.
          example: null
          required: false
          schema:
            type: string
            description: Search within the user name or username.
            example: null
            nullable: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - view: x
                        avatar: https://public.onlyfans.com/files/example/200000001/avatar.jpg
                        avatarThumbs:
                          c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/example/200000001/avatar.jpg
                          c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/example/200000001/avatar.jpg
                        header: https://public.onlyfans.com/files/example/200000001/header_image.jpg
                        headerSize:
                          width: 4028
                          height: 1250
                        headerThumbs:
                          w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/example/200000001/header_image.jpg
                          w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/example/200000001/header_image.jpg
                        id: 200000001
                        name: Example User
                        username: exampleuser
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: true
                        canPayInternal: false
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: true
                        canAddSubscriber: false
                        subscribePrice: 0
                        isPaywallRequired: true
                        isActive: true
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: false
                        subscribedOnExpire: null
                        subscribedOnExpiredNow: null
                        subscribedOnDuration: null
                        listsStates:
                          - id: following
                            type: following
                            name: Following
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: fans
                            type: fans
                            name: Fans
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          - id: recent
                            type: recent
                            name: Recent (last 24 hours)
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                        canReport: false
                        canReceiveChatMessage: false
                        hideChat: false
                        lastSeen: 2026-06-26T16:17:08+00:00
                        isPerformer: true
                        isRealPerformer: true
                        subscribedByData: null
                        subscribedOnData: null
                        canTrialSend: false
                        isBlocked: true
                        promoOffers: []
                    hasMore: true
                    nextOffset: 10
                  _pagination:
                    next_page: https://app.onlyfansapi.com/api/acct_abc123/users/blocked?offset=10&limit=10
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999839
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49997
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - view: x
                            avatar: https://public.onlyfans.com/files/example/200000001/avatar.jpg
                            avatarThumbs:
                              c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/example/200000001/avatar.jpg
                              c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/example/200000001/avatar.jpg
                            header: https://public.onlyfans.com/files/example/200000001/header_image.jpg
                            headerSize:
                              width: 4028
                              height: 1250
                            headerThumbs:
                              w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/example/200000001/header_image.jpg
                              w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/example/200000001/header_image.jpg
                            id: 200000001
                            name: Example User
                            username: exampleuser
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: true
                            canPayInternal: false
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: true
                            canAddSubscriber: false
                            subscribePrice: 0
                            isPaywallRequired: true
                            isActive: true
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: false
                            subscribedOnExpire: null
                            subscribedOnExpiredNow: null
                            subscribedOnDuration: null
                            listsStates:
                              - id: following
                                type: following
                                name: Following
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              - id: fans
                                type: fans
                                name: Fans
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: null
                              - id: recent
                                type: recent
                                name: Recent (last 24 hours)
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              - id: muted
                                type: muted
                                name: Muted
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                            canReport: false
                            canReceiveChatMessage: false
                            hideChat: false
                            lastSeen: 2026-06-26T16:17:08+00:00
                            isPerformer: true
                            isRealPerformer: true
                            subscribedByData: null
                            subscribedOnData: null
                            canTrialSend: false
                            isBlocked: true
                            promoOffers: []
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: x
                            avatar:
                              type: string
                              example: https://public.onlyfans.com/files/example/200000001/avatar.jpg
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/c50/example/200000001/avatar.jpg
                                c144:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/c144/example/200000001/avatar.jpg
                            header:
                              type: string
                              example: https://public.onlyfans.com/files/example/200000001/header_image.jpg
                            headerSize:
                              type: object
                              properties:
                                width:
                                  type: integer
                                  example: 4028
                                height:
                                  type: integer
                                  example: 1250
                            headerThumbs:
                              type: object
                              properties:
                                w480:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/w480/example/200000001/header_image.jpg
                                w760:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/w760/example/200000001/header_image.jpg
                            id:
                              type: integer
                              example: 200000001
                            name:
                              type: string
                              example: Example User
                            username:
                              type: string
                              example: exampleuser
                            canLookStory:
                              type: boolean
                              example: false
                            canCommentStory:
                              type: boolean
                              example: false
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: true
                            canPayInternal:
                              type: boolean
                              example: false
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: false
                            tipsTextEnabled:
                              type: boolean
                              example: true
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: true
                            canAddSubscriber:
                              type: boolean
                              example: false
                            subscribePrice:
                              type: integer
                              example: 0
                            isPaywallRequired:
                              type: boolean
                              example: true
                            isActive:
                              type: boolean
                              example: true
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: false
                            subscribedByExpire:
                              type: string
                              example: null
                              nullable: true
                            subscribedByExpireDate:
                              type: string
                              example: null
                              nullable: true
                            subscribedByAutoprolong:
                              type: string
                              example: null
                              nullable: true
                            subscribedIsExpiredNow:
                              type: string
                              example: null
                              nullable: true
                            currentSubscribePrice:
                              type: string
                              example: null
                              nullable: true
                            subscribedOn:
                              type: boolean
                              example: false
                            subscribedOnExpire:
                              type: string
                              example: null
                              nullable: true
                            subscribedOnExpiredNow:
                              type: string
                              example: null
                              nullable: true
                            subscribedOnDuration:
                              type: string
                              example: null
                              nullable: true
                            listsStates:
                              type: array
                              example:
                                - id: following
                                  type: following
                                  name: Following
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                - id: fans
                                  type: fans
                                  name: Fans
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: null
                                - id: recent
                                  type: recent
                                  name: Recent (last 24 hours)
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                - id: muted
                                  type: muted
                                  name: Muted
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: following
                                  type:
                                    type: string
                                    example: following
                                  name:
                                    type: string
                                    example: Following
                                  hasUser:
                                    type: boolean
                                    example: false
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: SYSTEM_LIST
                            canReport:
                              type: boolean
                              example: false
                            canReceiveChatMessage:
                              type: boolean
                              example: false
                            hideChat:
                              type: boolean
                              example: false
                            lastSeen:
                              type: string
                              example: 2026-06-26T16:17:08+00:00
                            isPerformer:
                              type: boolean
                              example: true
                            isRealPerformer:
                              type: boolean
                              example: true
                            subscribedByData:
                              type: string
                              example: null
                              nullable: true
                            subscribedOnData:
                              type: string
                              example: null
                              nullable: true
                            canTrialSend:
                              type: boolean
                              example: false
                            isBlocked:
                              type: boolean
                              example: true
                            promoOffers:
                              type: array
                              example: []
                      hasMore:
                        type: boolean
                        example: true
                      nextOffset:
                        type: integer
                        example: 10
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: https://app.onlyfansapi.com/api/acct_abc123/users/blocked?offset=10&limit=10
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999839
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49997
      tags:
        - Blocked / Restricted Users
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Restricted Users (/api-reference/blocked-restricted-users/list-restricted-users)

Get a paginated list of users the account has restricted. Optionally search with `query`.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/users/restricted
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/users/restricted:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Restricted Users
      operationId: listRestrictedUsers
      description: Get a paginated list of users the account has restricted.
        Optionally search with `query`.
      parameters:
        - in: query
          name: limit
          description: Number of users to return per page (1-50). Must be at least 1. Must
            not be greater than 50.
          example: 10
          required: false
          schema:
            type: integer
            description: Number of users to return per page (1-50). Must be at least 1. Must
              not be greater than 50.
            example: 10
        - in: query
          name: offset
          description: Number of users to skip for pagination. Must be at least 0.
          example: 0
          required: false
          schema:
            type: integer
            description: Number of users to skip for pagination. Must be at least 0.
            example: 0
        - in: query
          name: query
          description: Search within the user name or username.
          example: null
          required: false
          schema:
            type: string
            description: Search within the user name or username.
            example: null
            nullable: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - view: x
                        avatar: https://public.onlyfans.com/files/example/200000002/avatar.jpg
                        avatarThumbs:
                          c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/example/200000002/avatar.jpg
                          c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/example/200000002/avatar.jpg
                        header: https://public.onlyfans.com/files/example/200000002/header_image.jpg
                        headerSize:
                          width: 4028
                          height: 1250
                        headerThumbs:
                          w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/example/200000002/header_image.jpg
                          w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/example/200000002/header_image.jpg
                        id: 200000002
                        name: Another User
                        username: anotheruser
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: true
                        canPayInternal: true
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: false
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: true
                        canAddSubscriber: true
                        subscribePrice: 0
                        isPaywallRequired: true
                        isActive: true
                        isRestricted: true
                        canRestrict: false
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: false
                        subscribedOnExpire: null
                        subscribedOnExpiredNow: null
                        subscribedOnDuration: null
                        listsStates:
                          - id: following
                            type: following
                            name: Following
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: fans
                            type: fans
                            name: Fans
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          - id: recent
                            type: recent
                            name: Recent (last 24 hours)
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                        canReport: false
                        canReceiveChatMessage: false
                        hideChat: false
                        lastSeen: 2026-06-26T16:37:48+00:00
                        isPerformer: true
                        isRealPerformer: true
                        subscribedByData: null
                        subscribedOnData: null
                        canTrialSend: false
                        isBlocked: false
                    hasMore: true
                    nextOffset: 10
                  _pagination:
                    next_page: https://app.onlyfansapi.com/api/acct_abc123/users/restrict?offset=10&limit=10
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999839
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49997
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - view: x
                            avatar: https://public.onlyfans.com/files/example/200000002/avatar.jpg
                            avatarThumbs:
                              c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/example/200000002/avatar.jpg
                              c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/example/200000002/avatar.jpg
                            header: https://public.onlyfans.com/files/example/200000002/header_image.jpg
                            headerSize:
                              width: 4028
                              height: 1250
                            headerThumbs:
                              w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/example/200000002/header_image.jpg
                              w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/example/200000002/header_image.jpg
                            id: 200000002
                            name: Another User
                            username: anotheruser
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: true
                            canPayInternal: true
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: false
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: true
                            canAddSubscriber: true
                            subscribePrice: 0
                            isPaywallRequired: true
                            isActive: true
                            isRestricted: true
                            canRestrict: false
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: false
                            subscribedOnExpire: null
                            subscribedOnExpiredNow: null
                            subscribedOnDuration: null
                            listsStates:
                              - id: following
                                type: following
                                name: Following
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              - id: fans
                                type: fans
                                name: Fans
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: null
                              - id: recent
                                type: recent
                                name: Recent (last 24 hours)
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              - id: muted
                                type: muted
                                name: Muted
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                            canReport: false
                            canReceiveChatMessage: false
                            hideChat: false
                            lastSeen: 2026-06-26T16:37:48+00:00
                            isPerformer: true
                            isRealPerformer: true
                            subscribedByData: null
                            subscribedOnData: null
                            canTrialSend: false
                            isBlocked: false
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: x
                            avatar:
                              type: string
                              example: https://public.onlyfans.com/files/example/200000002/avatar.jpg
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/c50/example/200000002/avatar.jpg
                                c144:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/c144/example/200000002/avatar.jpg
                            header:
                              type: string
                              example: https://public.onlyfans.com/files/example/200000002/header_image.jpg
                            headerSize:
                              type: object
                              properties:
                                width:
                                  type: integer
                                  example: 4028
                                height:
                                  type: integer
                                  example: 1250
                            headerThumbs:
                              type: object
                              properties:
                                w480:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/w480/example/200000002/header_image.jpg
                                w760:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/w760/example/200000002/header_image.jpg
                            id:
                              type: integer
                              example: 200000002
                            name:
                              type: string
                              example: Another User
                            username:
                              type: string
                              example: anotheruser
                            canLookStory:
                              type: boolean
                              example: false
                            canCommentStory:
                              type: boolean
                              example: false
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: true
                            canPayInternal:
                              type: boolean
                              example: true
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: false
                            tipsTextEnabled:
                              type: boolean
                              example: false
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: true
                            canAddSubscriber:
                              type: boolean
                              example: true
                            subscribePrice:
                              type: integer
                              example: 0
                            isPaywallRequired:
                              type: boolean
                              example: true
                            isActive:
                              type: boolean
                              example: true
                            isRestricted:
                              type: boolean
                              example: true
                            canRestrict:
                              type: boolean
                              example: false
                            subscribedBy:
                              type: boolean
                              example: false
                            subscribedByExpire:
                              type: string
                              example: null
                              nullable: true
                            subscribedByExpireDate:
                              type: string
                              example: null
                              nullable: true
                            subscribedByAutoprolong:
                              type: string
                              example: null
                              nullable: true
                            subscribedIsExpiredNow:
                              type: string
                              example: null
                              nullable: true
                            currentSubscribePrice:
                              type: string
                              example: null
                              nullable: true
                            subscribedOn:
                              type: boolean
                              example: false
                            subscribedOnExpire:
                              type: string
                              example: null
                              nullable: true
                            subscribedOnExpiredNow:
                              type: string
                              example: null
                              nullable: true
                            subscribedOnDuration:
                              type: string
                              example: null
                              nullable: true
                            listsStates:
                              type: array
                              example:
                                - id: following
                                  type: following
                                  name: Following
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                - id: fans
                                  type: fans
                                  name: Fans
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: null
                                - id: recent
                                  type: recent
                                  name: Recent (last 24 hours)
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                - id: muted
                                  type: muted
                                  name: Muted
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: following
                                  type:
                                    type: string
                                    example: following
                                  name:
                                    type: string
                                    example: Following
                                  hasUser:
                                    type: boolean
                                    example: false
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: SYSTEM_LIST
                            canReport:
                              type: boolean
                              example: false
                            canReceiveChatMessage:
                              type: boolean
                              example: false
                            hideChat:
                              type: boolean
                              example: false
                            lastSeen:
                              type: string
                              example: 2026-06-26T16:37:48+00:00
                            isPerformer:
                              type: boolean
                              example: true
                            isRealPerformer:
                              type: boolean
                              example: true
                            subscribedByData:
                              type: string
                              example: null
                              nullable: true
                            subscribedOnData:
                              type: string
                              example: null
                              nullable: true
                            canTrialSend:
                              type: boolean
                              example: false
                            isBlocked:
                              type: boolean
                              example: false
                      hasMore:
                        type: boolean
                        example: true
                      nextOffset:
                        type: integer
                        example: 10
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: https://app.onlyfansapi.com/api/acct_abc123/users/restrict?offset=10&limit=10
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999839
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49997
      tags:
        - Blocked / Restricted Users
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Profitability History (/api-reference/analytics-financial/get-profitability-history)

Get historical profitability data for a specific account over multiple months.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/analytics/financial/profitability/{account}/history
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/analytics/financial/profitability/{account}/history:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Profitability History
      operationId: getProfitabilityHistory
      description: Get historical profitability data for a specific account over
        multiple months.
      parameters:
        - in: query
          name: account_prefixed_id
          description: The account prefixed ID.
          example: acct_abc123
          required: true
          schema:
            type: string
            description: The account prefixed ID.
            example: acct_abc123
        - in: query
          name: months
          description: Number of months of history to retrieve (1-60, default 12). Must be
            at least 1. Must not be greater than 60.
          example: 12
          required: false
          schema:
            type: integer
            description: Number of months of history to retrieve (1-60, default 12). Must be
              at least 1. Must not be greater than 60.
            example: 12
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - onlyFansUserId: 12345
                      creatorName: Creator Name
                      year: 2024
                      month: 1
                      projectedNet: "10000.00"
                      commissionRate: "20.00"
                      commissionAmount: "2000.00"
                      costs: []
                      totalCosts: "500.00"
                      agencyEarnings: "2000.00"
                      profit: "1500.00"
                      marginPercentage: "75.00"
                      hasCommissionForPeriod: true
                      hasCostsForPeriod: true
                      activeMilestones: null
                      referralNote: null
                      ratePeriods: []
                properties:
                  data:
                    type: array
                    example:
                      - onlyFansUserId: 12345
                        creatorName: Creator Name
                        year: 2024
                        month: 1
                        projectedNet: "10000.00"
                        commissionRate: "20.00"
                        commissionAmount: "2000.00"
                        costs: []
                        totalCosts: "500.00"
                        agencyEarnings: "2000.00"
                        profit: "1500.00"
                        marginPercentage: "75.00"
                        hasCommissionForPeriod: true
                        hasCostsForPeriod: true
                        activeMilestones: null
                        referralNote: null
                        ratePeriods: []
                    items:
                      type: object
                      properties:
                        onlyFansUserId:
                          type: integer
                          example: 12345
                        creatorName:
                          type: string
                          example: Creator Name
                        year:
                          type: integer
                          example: 2024
                        month:
                          type: integer
                          example: 1
                        projectedNet:
                          type: string
                          example: "10000.00"
                        commissionRate:
                          type: string
                          example: "20.00"
                        commissionAmount:
                          type: string
                          example: "2000.00"
                        costs:
                          type: array
                          example: []
                        totalCosts:
                          type: string
                          example: "500.00"
                        agencyEarnings:
                          type: string
                          example: "2000.00"
                        profit:
                          type: string
                          example: "1500.00"
                        marginPercentage:
                          type: string
                          example: "75.00"
                        hasCommissionForPeriod:
                          type: boolean
                          example: true
                        hasCostsForPeriod:
                          type: boolean
                          example: true
                        activeMilestones:
                          type: string
                          example: null
                          nullable: true
                        referralNote:
                          type: string
                          example: null
                          nullable: true
                        ratePeriods:
                          type: array
                          example: []
      tags:
        - Analytics - Financial
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Profitability (/api-reference/analytics-financial/get-profitability)

Calculate profitability for creators including revenue, costs, commissions, and margins for a specific month.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/analytics/financial/profitability
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/analytics/financial/profitability:
    post:
      summary: Get Profitability
      operationId: getProfitability
      description: Calculate profitability for creators including revenue, costs,
        commissions, and margins for a specific month.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - onlyFansUserId: 12345
                      creatorName: Creator Name
                      year: 2024
                      month: 6
                      projectedNet: "10000.00"
                      commissionRate: "20.00"
                      commissionAmount: "2000.00"
                      costs: []
                      totalCosts: "500.00"
                      agencyEarnings: "2000.00"
                      profit: "1500.00"
                      marginPercentage: "75.00"
                      hasCommissionForPeriod: true
                      hasCostsForPeriod: true
                      activeMilestones: null
                      referralNote: null
                      ratePeriods: []
                properties:
                  data:
                    type: array
                    example:
                      - onlyFansUserId: 12345
                        creatorName: Creator Name
                        year: 2024
                        month: 6
                        projectedNet: "10000.00"
                        commissionRate: "20.00"
                        commissionAmount: "2000.00"
                        costs: []
                        totalCosts: "500.00"
                        agencyEarnings: "2000.00"
                        profit: "1500.00"
                        marginPercentage: "75.00"
                        hasCommissionForPeriod: true
                        hasCostsForPeriod: true
                        activeMilestones: null
                        referralNote: null
                        ratePeriods: []
                    items:
                      type: object
                      properties:
                        onlyFansUserId:
                          type: integer
                          example: 12345
                        creatorName:
                          type: string
                          example: Creator Name
                        year:
                          type: integer
                          example: 2024
                        month:
                          type: integer
                          example: 6
                        projectedNet:
                          type: string
                          example: "10000.00"
                        commissionRate:
                          type: string
                          example: "20.00"
                        commissionAmount:
                          type: string
                          example: "2000.00"
                        costs:
                          type: array
                          example: []
                        totalCosts:
                          type: string
                          example: "500.00"
                        agencyEarnings:
                          type: string
                          example: "2000.00"
                        profit:
                          type: string
                          example: "1500.00"
                        marginPercentage:
                          type: string
                          example: "75.00"
                        hasCommissionForPeriod:
                          type: boolean
                          example: true
                        hasCostsForPeriod:
                          type: boolean
                          example: true
                        activeMilestones:
                          type: string
                          example: null
                          nullable: true
                        referralNote:
                          type: string
                          example: null
                          nullable: true
                        ratePeriods:
                          type: array
                          example: []
      tags:
        - Analytics - Financial
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                account_ids:
                  type: array
                  description: Array of account prefixed IDs
                  example:
                    - acc_abc123
                    - acc_def456
                  items:
                    type: string
                year:
                  type: integer
                  description: The year to calculate profitability for
                  example: 2024
                month:
                  type: integer
                  description: The month to calculate profitability for (1-12)
                  example: 6
              required:
                - account_ids
                - year
                - month
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Revenue Forecast (/api-reference/analytics-financial/get-revenue-forecast)

Generate revenue or churn forecasts using statistical models (Moving Average, Linear Regression, ARIMA, SARIMA).

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/analytics/financial/forecast
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/analytics/financial/forecast:
    post:
      summary: Get Revenue Forecast
      operationId: getRevenueForecast
      description: Generate revenue or churn forecasts using statistical models
        (Moving Average, Linear Regression, ARIMA, SARIMA).
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  metric: revenue
                  model: linear_regression
                  historical:
                    - date: 2024-01-01
                      value: 500
                  forecast:
                    - date: 2024-02-01
                      value: 550
                properties:
                  metric:
                    type: string
                    example: revenue
                  model:
                    type: string
                    example: linear_regression
                  historical:
                    type: array
                    example:
                      - date: 2024-01-01
                        value: 500
                    items:
                      type: object
                      properties:
                        date:
                          type: string
                          example: 2024-01-01
                        value:
                          type: number
                          example: 500
                  forecast:
                    type: array
                    example:
                      - date: 2024-02-01
                        value: 550
                    items:
                      type: object
                      properties:
                        date:
                          type: string
                          example: 2024-02-01
                        value:
                          type: number
                          example: 550
      tags:
        - Analytics - Financial
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                account_ids:
                  type: array
                  description: Array of account prefixed IDs
                  example:
                    - acc_abc123
                    - acc_def456
                  items:
                    type: string
                metric:
                  type: string
                  description: The metric to forecast
                  example: revenue
                  enum:
                    - revenue
                    - churn_percentage
                model:
                  type: string
                  description: The forecasting model to use
                  example: linear_regression
                  enum:
                    - moving_average
                    - linear_regression
                    - arima
                    - sarima
                historical_days:
                  type: integer
                  description: Number of historical days to analyze (30-730)
                  example: 90
                forecast_days:
                  type: integer
                  description: Number of days to forecast (7-365)
                  example: 30
              required:
                - account_ids
                - metric
                - model
                - historical_days
                - forecast_days
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Transaction Summary (/api-reference/analytics-financial/get-transaction-summary)

Get transaction summary including counts for succeeded, refunded, and disputed transactions, plus gross, net, and fee totals.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/analytics/financial/transactions/summary
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/analytics/financial/transactions/summary:
    post:
      summary: Get Transaction Summary
      operationId: getTransactionSummary
      description: Get transaction summary including counts for succeeded, refunded,
        and disputed transactions, plus gross, net, and fee totals.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  succeeded_count: 150
                  refunded_count: 5
                  disputed_count: 2
                  total_gross: 20000
                  total_net: 16000
                  total_fees: 4000
                properties:
                  succeeded_count:
                    type: integer
                    example: 150
                  refunded_count:
                    type: integer
                    example: 5
                  disputed_count:
                    type: integer
                    example: 2
                  total_gross:
                    type: number
                    example: 20000
                  total_net:
                    type: number
                    example: 16000
                  total_fees:
                    type: number
                    example: 4000
      tags:
        - Analytics - Financial
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                account_ids:
                  type: array
                  description: Array of account prefixed IDs
                  example:
                    - acc_abc123
                    - acc_def456
                  items:
                    type: string
                start_date:
                  type: string
                  description: The start date (ISO 8601 format)
                  example: 2024-01-01
                end_date:
                  type: string
                  description: The end date (ISO 8601 format)
                  example: 2024-12-31
              required:
                - account_ids
                - start_date
                - end_date
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Transactions By Type (/api-reference/analytics-financial/get-transactions-by-type)

Get transaction totals grouped by transaction type (subscriptions, tips, messages, etc.).

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/analytics/financial/transactions/by-type
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/analytics/financial/transactions/by-type:
    post:
      summary: Get Transactions By Type
      operationId: getTransactionsByType
      description: Get transaction totals grouped by transaction type (subscriptions,
        tips, messages, etc.).
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    type:
                      type: string
                      example: subscription
                    count:
                      type: integer
                      example: 100
                    total:
                      type: number
                      example: 5000
                example:
                  - type: subscription
                    count: 100
                    total: 5000
                  - type: tip
                    count: 50
                    total: 2500
      tags:
        - Analytics - Financial
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                account_ids:
                  type: array
                  description: Array of account prefixed IDs
                  example:
                    - acc_abc123
                    - acc_def456
                  items:
                    type: string
                start_date:
                  type: string
                  description: The start date (ISO 8601 format)
                  example: 2024-01-01
                end_date:
                  type: string
                  description: The end date (ISO 8601 format)
                  example: 2024-12-31
              required:
                - account_ids
                - start_date
                - end_date
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Create Client Session (/api-reference/client-sessions/create-client-session)

Create Client Session Token for later use in embedded auth components - eg. via @onlyfansapi/auth npm package.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/client-sessions
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/client-sessions:
    post:
      summary: Create Client Session
      operationId: createClientSession
      description: Create Client Session Token for later use in embedded auth
        components - eg. via @onlyfansapi/auth npm package.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    token: ofapi_cs_OriR8Sdocp0f97eFOdbMMZtiz4Aw5FLX
                    display_name: "STRLCxGLVC Agency / Model: Stella"
                    client_reference_id: my_crm_model_12345
                  _meta:
                    _credits:
                      used: 0
                      balance: 224907
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49999
                properties:
                  data:
                    type: object
                    properties:
                      token:
                        type: string
                        example: ofapi_cs_OriR8Sdocp0f97eFOdbMMZtiz4Aw5FLX
                      display_name:
                        type: string
                        example: "STRLCxGLVC Agency / Model: Stella"
                      client_reference_id:
                        type: string
                        example: my_crm_model_12345
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 224907
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49999
      tags:
        - Client Sessions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                display_name:
                  type: string
                  description: Display Name of the account visible in your OnlyFansAPI Console
                    Dashboard.
                  example: "STRLCxGLVC Agency / Model: Stella"
                client_reference_id:
                  type: string
                  description: Your Internal Reference ID for the connected account.
                  example: my_crm_model_12345
                proxy_country:
                  type: string
                  description: ""
                  example: gb
                  enum:
                    - us
                    - uk
                    - gb
                  nullable: true
              required:
                - display_name
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Delete Chat (/api-reference/chats/delete-chat)

Delete a specific chat.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/chats/{chat_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/chats/{chat_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The ID of the chat to delete, usually a fan's OnlyFans User ID
        example: "123"
        required: true
        schema:
          type: string
    delete:
      summary: Delete Chat
      operationId: deleteChat
      description: Delete a specific chat.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999884
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49971
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999884
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49971
      tags:
        - Chats
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Hide Chat (/api-reference/chats/hide-chat)

Hide a specific chat from the chat list. To unhide this chat, send a new message to the user.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/chats/{chat_id}/hide
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/chats/{chat_id}/hide:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The ID of the chat to hide, usually a fan's OnlyFans User ID
        example: "123"
        required: true
        schema:
          type: string
    post:
      summary: Hide Chat
      operationId: hideChat
      description: Hide a specific chat from the chat list. To unhide this chat, send
        a new message to the user.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999884
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49971
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999884
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49971
      tags:
        - Chats
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Chat Media (Gallery) (/api-reference/chats/list-chat-media-gallery)

List media files shared in a specific chat.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/chats/{chat_id}/media
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/chats/{chat_id}/media:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The ID of the chat to get media from, usually a fan's OnlyFans User ID
        example: "123"
        required: true
        schema:
          type: string
    get:
      summary: List Chat Media (Gallery)
      operationId: listChatMediaGallery
      description: List media files shared in a specific chat.
      parameters:
        - in: query
          name: type
          description: Filter by specific media types. Keep empty to return all.
          example: claims
          required: false
          schema:
            type: string
            description: Filter by specific media types. Keep empty to return all.
            example: claims
            enum:
              - photos
              - videos
              - audios
            nullable: true
        - in: query
          name: limit
          description: Number of medias to return. Default = 20
          example: 20
          required: false
          schema:
            type: string
            description: Number of medias to return. Default = 20
            example: 20
        - in: query
          name: offset
          description: Number of medias to skip for pagination
          example: 0
          required: false
          schema:
            type: string
            description: Number of medias to skip for pagination
            example: 0
        - in: query
          name: skip_users
          description: Whether to skip user details in the response (`all` or `none`).
            Defaults to `all`.
          example: all
          required: false
          schema:
            type: string
            description: Whether to skip user details in the response (`all` or `none`).
              Defaults to `all`.
            example: all
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - responseType: message
                        text: Text message!
                        giphyId: null
                        lockedText: true
                        isFree: true
                        price: 0
                        isMediaReady: true
                        mediaCount: 1
                        media:
                          - id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: 2025-01-01T00:00:00+00:00
                            isReady: true
                            files:
                              full:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 2048
                                height: 1360
                                size: 0
                                sources: []
                              thumb:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 960
                                height: 638
                                size: 0
                              squarePreview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 960
                                height: 960
                                size: 0
                            duration: 0
                            hasCustomPreview: false
                            videoSources:
                              "240": null
                              "720": null
                        previews: []
                        isTip: false
                        isReportedByMe: false
                        isCouplePeopleMedia: false
                        queueId: 123
                        isMarkdownDisabled: true
                        releaseForms: []
                        fromUser:
                          id: 123
                          _view: t
                        isFromQueue: false
                        id: 123
                        isOpened: false
                        isNew: false
                        createdAt: 2025-01-01T00:00:00+00:00
                        changedAt: 2025-01-01T00:00:00+00:00
                        cancelSeconds: 0
                        isLiked: false
                        canPurchase: false
                        canPurchaseReason: free
                        canReport: false
                        canBePinned: true
                        isPinned: false
                    hasMore: false
                    nextLastId: "123"
                  _meta:
                    _credits:
                      used: 1
                      balance: 999964345
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49985
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - responseType: message
                            text: Text message!
                            giphyId: null
                            lockedText: true
                            isFree: true
                            price: 0
                            isMediaReady: true
                            mediaCount: 1
                            media:
                              - id: 123
                                type: photo
                                convertedToVideo: false
                                canView: true
                                hasError: false
                                createdAt: 2025-01-01T00:00:00+00:00
                                isReady: true
                                files:
                                  full:
                                    url: https://cdn2.onlyfans.com/files/...
                                    width: 2048
                                    height: 1360
                                    size: 0
                                    sources: []
                                  thumb:
                                    url: https://cdn2.onlyfans.com/files/...
                                    width: 300
                                    height: 300
                                    size: 0
                                  preview:
                                    url: https://cdn2.onlyfans.com/files/...
                                    width: 960
                                    height: 638
                                    size: 0
                                  squarePreview:
                                    url: https://cdn2.onlyfans.com/files/...
                                    width: 960
                                    height: 960
                                    size: 0
                                duration: 0
                                hasCustomPreview: false
                                videoSources:
                                  "240": null
                                  "720": null
                            previews: []
                            isTip: false
                            isReportedByMe: false
                            isCouplePeopleMedia: false
                            queueId: 123
                            isMarkdownDisabled: true
                            releaseForms: []
                            fromUser:
                              id: 123
                              _view: t
                            isFromQueue: false
                            id: 123
                            isOpened: false
                            isNew: false
                            createdAt: 2025-01-01T00:00:00+00:00
                            changedAt: 2025-01-01T00:00:00+00:00
                            cancelSeconds: 0
                            isLiked: false
                            canPurchase: false
                            canPurchaseReason: free
                            canReport: false
                            canBePinned: true
                            isPinned: false
                        items:
                          type: object
                          properties:
                            responseType:
                              type: string
                              example: message
                            text:
                              type: string
                              example: Text message!
                            giphyId:
                              type: string
                              example: null
                              nullable: true
                            lockedText:
                              type: boolean
                              example: true
                            isFree:
                              type: boolean
                              example: true
                            price:
                              type: integer
                              example: 0
                            isMediaReady:
                              type: boolean
                              example: true
                            mediaCount:
                              type: integer
                              example: 1
                            media:
                              type: array
                              example:
                                - id: 123
                                  type: photo
                                  convertedToVideo: false
                                  canView: true
                                  hasError: false
                                  createdAt: 2025-01-01T00:00:00+00:00
                                  isReady: true
                                  files:
                                    full:
                                      url: https://cdn2.onlyfans.com/files/...
                                      width: 2048
                                      height: 1360
                                      size: 0
                                      sources: []
                                    thumb:
                                      url: https://cdn2.onlyfans.com/files/...
                                      width: 300
                                      height: 300
                                      size: 0
                                    preview:
                                      url: https://cdn2.onlyfans.com/files/...
                                      width: 960
                                      height: 638
                                      size: 0
                                    squarePreview:
                                      url: https://cdn2.onlyfans.com/files/...
                                      width: 960
                                      height: 960
                                      size: 0
                                  duration: 0
                                  hasCustomPreview: false
                                  videoSources:
                                    "240": null
                                    "720": null
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  type:
                                    type: string
                                    example: photo
                                  convertedToVideo:
                                    type: boolean
                                    example: false
                                  canView:
                                    type: boolean
                                    example: true
                                  hasError:
                                    type: boolean
                                    example: false
                                  createdAt:
                                    type: string
                                    example: 2025-01-01T00:00:00+00:00
                                  isReady:
                                    type: boolean
                                    example: true
                                  files:
                                    type: object
                                    properties:
                                      full:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                            example: https://cdn2.onlyfans.com/files/...
                                          width:
                                            type: integer
                                            example: 2048
                                          height:
                                            type: integer
                                            example: 1360
                                          size:
                                            type: integer
                                            example: 0
                                          sources:
                                            type: array
                                            example: []
                                      thumb:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                            example: https://cdn2.onlyfans.com/files/...
                                          width:
                                            type: integer
                                            example: 300
                                          height:
                                            type: integer
                                            example: 300
                                          size:
                                            type: integer
                                            example: 0
                                      preview:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                            example: https://cdn2.onlyfans.com/files/...
                                          width:
                                            type: integer
                                            example: 960
                                          height:
                                            type: integer
                                            example: 638
                                          size:
                                            type: integer
                                            example: 0
                                      squarePreview:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                            example: https://cdn2.onlyfans.com/files/...
                                          width:
                                            type: integer
                                            example: 960
                                          height:
                                            type: integer
                                            example: 960
                                          size:
                                            type: integer
                                            example: 0
                                  duration:
                                    type: integer
                                    example: 0
                                  hasCustomPreview:
                                    type: boolean
                                    example: false
                                  videoSources:
                                    type: object
                                    properties:
                                      "240":
                                        type: string
                                        example: null
                                        nullable: true
                                      "720":
                                        type: string
                                        example: null
                                        nullable: true
                            previews:
                              type: array
                              example: []
                            isTip:
                              type: boolean
                              example: false
                            isReportedByMe:
                              type: boolean
                              example: false
                            isCouplePeopleMedia:
                              type: boolean
                              example: false
                            queueId:
                              type: integer
                              example: 123
                            isMarkdownDisabled:
                              type: boolean
                              example: true
                            releaseForms:
                              type: array
                              example: []
                            fromUser:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                _view:
                                  type: string
                                  example: t
                            isFromQueue:
                              type: boolean
                              example: false
                            id:
                              type: integer
                              example: 123
                            isOpened:
                              type: boolean
                              example: false
                            isNew:
                              type: boolean
                              example: false
                            createdAt:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            changedAt:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            cancelSeconds:
                              type: integer
                              example: 0
                            isLiked:
                              type: boolean
                              example: false
                            canPurchase:
                              type: boolean
                              example: false
                            canPurchaseReason:
                              type: string
                              example: free
                            canReport:
                              type: boolean
                              example: false
                            canBePinned:
                              type: boolean
                              example: true
                            isPinned:
                              type: boolean
                              example: false
                      hasMore:
                        type: boolean
                        example: false
                      nextLastId:
                        type: string
                        example: "123"
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999964345
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49985
      tags:
        - Chats
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Chats (/api-reference/chats/list-chats)

Get the list of chats for an Account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/chats
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/chats:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Chats
      operationId: listChats
      description: Get the list of chats for an Account.
      parameters:
        - in: query
          name: limit
          description: Number of chats to return (1 - 100). Default = 10
          example: 10
          required: false
          schema:
            type: string
            description: Number of chats to return (1 - 100). Default = 10
            example: 10
        - in: query
          name: offset
          description: Number of chats to skip for pagination
          example: 0
          required: false
          schema:
            type: string
            description: Number of chats to skip for pagination
            example: 0
        - in: query
          name: skip_users
          description: Whether to skip user details in the response (`all` or `none`).
            Defaults to `all`.
          example: all
          required: false
          schema:
            type: string
            description: Whether to skip user details in the response (`all` or `none`).
              Defaults to `all`.
            example: all
            enum:
              - all
              - none
        - in: query
          name: order
          description: Sort order for chats (recent or old). Default = recent
          example: recent
          required: false
          schema:
            type: string
            description: Sort order for chats (recent or old). Default = recent
            example: recent
            enum:
              - recent
              - old
        - in: query
          name: filter
          description: Optionally, filter the chats by type.
          example: with_tips
          required: false
          schema:
            type: string
            description: Optionally, filter the chats by type.
            example: with_tips
            enum:
              - pinned
              - priority
              - unread
              - with_tips
              - unread_with_tips
        - in: query
          name: query
          description: Search query to filter chats
          example: John
          required: false
          schema:
            type: string
            description: Search query to filter chats
            example: John
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - canNotSendReason: false
                      canSendMessage: true
                      canGoToProfile: true
                      unreadMessagesCount: 1
                      hasUnreadTips: false
                      isMutedNotifications: false
                      lastMessage:
                        responseType: message
                        text: <p>Message text</p>
                        giphyId: null
                        lockedText: false
                        isFree: true
                        price: 0
                        isMediaReady: true
                        mediaCount: 0
                        media: []
                        previews: []
                        isTip: false
                        isReportedByMe: false
                        isCouplePeopleMedia: false
                        queueId: 123
                        isMarkdownDisabled: true
                        fromUser:
                          id: 123
                          _view: i
                        isFromQueue: true
                        canUnsendQueue: true
                        unsendSecondsQueue: 1000000
                        id: 123
                        isOpened: false
                        isNew: true
                        createdAt: 2025-01-01T01:01:01+00:00
                        changedAt: 2025-01-01T01:01:01+00:00
                        cancelSeconds: 86268
                        isLiked: false
                        canPurchase: false
                        canPurchaseReason: free
                        canReport: true
                        canBePinned: true
                        isPinned: false
                      lastReadMessageId: 0
                      hasPurchasedFeed: false
                      countPinnedMessages: 0
                      fan:
                        id: 123
                        name: Name
                        view: f
                        about: <p>About</p>
                        avatar: https://public.onlyfans.com/files/.../avatar.jpg
                        header: https://public.onlyfans.com/files/.../header.jpg
                        notice: ""
                        canChat: true
                        canEarn: true
                        tipsMax: 200
                        tipsMin: 5
                        website: null
                        hasLinks: false
                        isFriend: false
                        joinDate: 2025-01-01T01:01:01+00:00
                        lastSeen: 2025-01-01T01:01:01+00:00
                        location: Location
                        username: username
                        wishlist: null
                        canReport: true
                        hasLabels: true
                        hasStream: false
                        isBlocked: false
                        hasFriends: false
                        hasStories: false
                        headerSize:
                          width: 767
                          height: 1152
                        isVerified: true
                        postsCount: 123
                        audiosCount: 0
                        canRestrict: true
                        displayName: ""
                        isPerformer: true
                        listsStates:
                          - id: following
                            name: Following
                            type: following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: fans
                            name: Fans
                            type: fans
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: rebill_off
                            name: Renew Off
                            type: rebill_off
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          - id: rebill_on
                            name: Renew On
                            type: rebill_on
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: recent
                            name: Recent (last 24 hours)
                            type: recent
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: friends
                            name: Friends
                            type: friends
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          - id: muted
                            name: Muted
                            type: muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          - id: tagged
                            name: Tagged
                            type: tagged
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                        mediasCount: 123
                        photosCount: 123
                        tipsEnabled: true
                        videosCount: 123
                        avatarThumbs:
                          c50: https://thumbs.onlyfans.com/.../avatar.jpg
                          c144: https://thumbs.onlyfans.com/.../avatar.jpg
                        canLookStory: true
                        canTrialSend: false
                        headerThumbs:
                          w480: https://thumbs.onlyfans.com/.../header.jpg
                          w760: https://thumbs.onlyfans.com/.../header.jpg
                        isRestricted: false
                        subscribedBy: true
                        subscribedOn: true
                        canCreateTrial: false
                        canPayInternal: true
                        canUnsubscribe: true
                        favoritedCount: 123
                        favoritesCount: 123
                        hasPinnedPosts: false
                        isAdultContent: false
                        showMediaCount: true
                        subscribePrice: 0
                        canCommentStory: true
                        hasSavedStreams: false
                        isRealPerformer: true
                        showPostsInFeed: true
                        tipsMinInternal: 1
                        tipsTextEnabled: true
                        canAddSubscriber: false
                        subscribedByData:
                          price: 0
                          status: null
                          isMuted: false
                          duration: 22 days
                          newPrice: 0
                          expiredAt: 2025-01-01T01:01:01+00:00
                          renewedAt: 2025-01-01T01:01:01+00:00
                          subscribes:
                            - id: 123
                              date: 2025-01-01T01:01:01+00:00
                              type: regular
                              price: 0
                              action: subscribe
                              userId: 123
                              discount: 0
                              duration: 123
                              offerEnd: null
                              earningId: 0
                              isCurrent: true
                              startDate: 2025-01-01T01:01:01+00:00
                              cancelDate: null
                              expireDate: 2025-01-01T01:01:01+00:00
                              offerStart: null
                              regularPrice: 0
                              subscriberId: 123
                          subscribeAt: 2025-01-01T01:01:01+00:00
                          regularPrice: 0
                          discountPeriod: 1
                          subscribePrice: 0
                          discountPercent: 0
                          showPostsInFeed: true
                          discountStartedAt: null
                          unsubscribeReason: No reason given
                          discountFinishedAt: null
                          hasActivePaidSubscriptions: false
                        subscribedOnData:
                          price: 0
                          status: null
                          isMuted: false
                          duration: 22 days
                          newPrice: 0
                          tipsSumm: 0
                          expiredAt: 2025-01-01T01:01:01+00:00
                          postsSumm: 0
                          renewedAt: 2025-01-01T01:01:01+00:00
                          totalSumm: 0
                          subscribes:
                            - id: 123
                              date: 2025-01-01T01:01:01+00:00
                              type: auto
                              price: 0
                              action: subscribe
                              userId: 123
                              discount: 0
                              duration: 123
                              offerEnd: null
                              earningId: 0
                              isCurrent: true
                              startDate: 2025-01-01T01:01:01+00:00
                              cancelDate: null
                              expireDate: 2025-01-01T01:01:01+00:00
                              offerStart: null
                              regularPrice: 0
                              subscriberId: 123
                          streamsSumm: 0
                          subscribeAt: 2025-01-01T01:01:01+00:00
                          messagesSumm: 0
                          regularPrice: 4.99
                          discountPeriod: 1
                          subscribePrice: 4.99
                          subscribesSumm: 0
                          discountPercent: 0
                          discountStartedAt: null
                          unsubscribeReason: No reason given
                          discountFinishedAt: null
                          hasActivePaidSubscriptions: false
                        subscribersCount: null
                        hasNotViewedStory: false
                        isPaywallRequired: true
                        isReferrerAllowed: true
                        isSpringConnected: false
                        archivedPostsCount: 0
                        canCreatePromotion: false
                        hasScheduledStream: false
                        isSpotifyConnected: false
                        subscribedByExpire: false
                        finishedStreamsCount: 0
                        isPendingAutoprolong: false
                        isPrivateRestriction: false
                        showSubscribersCount: false
                        subscribedOnDuration: 22 days
                        canReceiveChatMessage: true
                        currentSubscribePrice: 0
                        firstPublishedPostDate: 2025-01-01T01:01:01+00:00
                        subscribedByExpireDate: 2025-01-01T01:01:01+00:00
                        subscribedIsExpiredNow: false
                        subscribedOnExpiredNow: false
                        subscribedByAutoprolong: true
                        privateArchivedPostsCount: 0
                        shouldShowFinishedStreams: false
                        isMarkdownDisabledForAbout: true
                        avatarHeaderConverterUpload: true
                  _pagination:
                    next_page: https://app.onlyfansapi.com/api/acct_XXXXXXXXXXX/chats?offset=10&limit=10
                  _meta:
                    _credits:
                      used: 1
                      balance: 1
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49999
                properties:
                  data:
                    type: array
                    example:
                      - canNotSendReason: false
                        canSendMessage: true
                        canGoToProfile: true
                        unreadMessagesCount: 1
                        hasUnreadTips: false
                        isMutedNotifications: false
                        lastMessage:
                          responseType: message
                          text: <p>Message text</p>
                          giphyId: null
                          lockedText: false
                          isFree: true
                          price: 0
                          isMediaReady: true
                          mediaCount: 0
                          media: []
                          previews: []
                          isTip: false
                          isReportedByMe: false
                          isCouplePeopleMedia: false
                          queueId: 123
                          isMarkdownDisabled: true
                          fromUser:
                            id: 123
                            _view: i
                          isFromQueue: true
                          canUnsendQueue: true
                          unsendSecondsQueue: 1000000
                          id: 123
                          isOpened: false
                          isNew: true
                          createdAt: 2025-01-01T01:01:01+00:00
                          changedAt: 2025-01-01T01:01:01+00:00
                          cancelSeconds: 86268
                          isLiked: false
                          canPurchase: false
                          canPurchaseReason: free
                          canReport: true
                          canBePinned: true
                          isPinned: false
                        lastReadMessageId: 0
                        hasPurchasedFeed: false
                        countPinnedMessages: 0
                        fan:
                          id: 123
                          name: Name
                          view: f
                          about: <p>About</p>
                          avatar: https://public.onlyfans.com/files/.../avatar.jpg
                          header: https://public.onlyfans.com/files/.../header.jpg
                          notice: ""
                          canChat: true
                          canEarn: true
                          tipsMax: 200
                          tipsMin: 5
                          website: null
                          hasLinks: false
                          isFriend: false
                          joinDate: 2025-01-01T01:01:01+00:00
                          lastSeen: 2025-01-01T01:01:01+00:00
                          location: Location
                          username: username
                          wishlist: null
                          canReport: true
                          hasLabels: true
                          hasStream: false
                          isBlocked: false
                          hasFriends: false
                          hasStories: false
                          headerSize:
                            width: 767
                            height: 1152
                          isVerified: true
                          postsCount: 123
                          audiosCount: 0
                          canRestrict: true
                          displayName: ""
                          isPerformer: true
                          listsStates:
                            - id: following
                              name: Following
                              type: following
                              hasUser: true
                              canAddUser: false
                              cannotAddUserReason: ALREADY_EXISTS
                            - id: fans
                              name: Fans
                              type: fans
                              hasUser: true
                              canAddUser: false
                              cannotAddUserReason: ALREADY_EXISTS
                            - id: rebill_off
                              name: Renew Off
                              type: rebill_off
                              hasUser: false
                              canAddUser: false
                              cannotAddUserReason: null
                            - id: rebill_on
                              name: Renew On
                              type: rebill_on
                              hasUser: true
                              canAddUser: false
                              cannotAddUserReason: ALREADY_EXISTS
                            - id: recent
                              name: Recent (last 24 hours)
                              type: recent
                              hasUser: false
                              canAddUser: false
                              cannotAddUserReason: SYSTEM_LIST
                            - id: friends
                              name: Friends
                              type: friends
                              hasUser: false
                              canAddUser: true
                              cannotAddUserReason: null
                            - id: muted
                              name: Muted
                              type: muted
                              hasUser: false
                              canAddUser: true
                              cannotAddUserReason: null
                            - id: tagged
                              name: Tagged
                              type: tagged
                              hasUser: false
                              canAddUser: false
                              cannotAddUserReason: SYSTEM_LIST
                          mediasCount: 123
                          photosCount: 123
                          tipsEnabled: true
                          videosCount: 123
                          avatarThumbs:
                            c50: https://thumbs.onlyfans.com/.../avatar.jpg
                            c144: https://thumbs.onlyfans.com/.../avatar.jpg
                          canLookStory: true
                          canTrialSend: false
                          headerThumbs:
                            w480: https://thumbs.onlyfans.com/.../header.jpg
                            w760: https://thumbs.onlyfans.com/.../header.jpg
                          isRestricted: false
                          subscribedBy: true
                          subscribedOn: true
                          canCreateTrial: false
                          canPayInternal: true
                          canUnsubscribe: true
                          favoritedCount: 123
                          favoritesCount: 123
                          hasPinnedPosts: false
                          isAdultContent: false
                          showMediaCount: true
                          subscribePrice: 0
                          canCommentStory: true
                          hasSavedStreams: false
                          isRealPerformer: true
                          showPostsInFeed: true
                          tipsMinInternal: 1
                          tipsTextEnabled: true
                          canAddSubscriber: false
                          subscribedByData:
                            price: 0
                            status: null
                            isMuted: false
                            duration: 22 days
                            newPrice: 0
                            expiredAt: 2025-01-01T01:01:01+00:00
                            renewedAt: 2025-01-01T01:01:01+00:00
                            subscribes:
                              - id: 123
                                date: 2025-01-01T01:01:01+00:00
                                type: regular
                                price: 0
                                action: subscribe
                                userId: 123
                                discount: 0
                                duration: 123
                                offerEnd: null
                                earningId: 0
                                isCurrent: true
                                startDate: 2025-01-01T01:01:01+00:00
                                cancelDate: null
                                expireDate: 2025-01-01T01:01:01+00:00
                                offerStart: null
                                regularPrice: 0
                                subscriberId: 123
                            subscribeAt: 2025-01-01T01:01:01+00:00
                            regularPrice: 0
                            discountPeriod: 1
                            subscribePrice: 0
                            discountPercent: 0
                            showPostsInFeed: true
                            discountStartedAt: null
                            unsubscribeReason: No reason given
                            discountFinishedAt: null
                            hasActivePaidSubscriptions: false
                          subscribedOnData:
                            price: 0
                            status: null
                            isMuted: false
                            duration: 22 days
                            newPrice: 0
                            tipsSumm: 0
                            expiredAt: 2025-01-01T01:01:01+00:00
                            postsSumm: 0
                            renewedAt: 2025-01-01T01:01:01+00:00
                            totalSumm: 0
                            subscribes:
                              - id: 123
                                date: 2025-01-01T01:01:01+00:00
                                type: auto
                                price: 0
                                action: subscribe
                                userId: 123
                                discount: 0
                                duration: 123
                                offerEnd: null
                                earningId: 0
                                isCurrent: true
                                startDate: 2025-01-01T01:01:01+00:00
                                cancelDate: null
                                expireDate: 2025-01-01T01:01:01+00:00
                                offerStart: null
                                regularPrice: 0
                                subscriberId: 123
                            streamsSumm: 0
                            subscribeAt: 2025-01-01T01:01:01+00:00
                            messagesSumm: 0
                            regularPrice: 4.99
                            discountPeriod: 1
                            subscribePrice: 4.99
                            subscribesSumm: 0
                            discountPercent: 0
                            discountStartedAt: null
                            unsubscribeReason: No reason given
                            discountFinishedAt: null
                            hasActivePaidSubscriptions: false
                          subscribersCount: null
                          hasNotViewedStory: false
                          isPaywallRequired: true
                          isReferrerAllowed: true
                          isSpringConnected: false
                          archivedPostsCount: 0
                          canCreatePromotion: false
                          hasScheduledStream: false
                          isSpotifyConnected: false
                          subscribedByExpire: false
                          finishedStreamsCount: 0
                          isPendingAutoprolong: false
                          isPrivateRestriction: false
                          showSubscribersCount: false
                          subscribedOnDuration: 22 days
                          canReceiveChatMessage: true
                          currentSubscribePrice: 0
                          firstPublishedPostDate: 2025-01-01T01:01:01+00:00
                          subscribedByExpireDate: 2025-01-01T01:01:01+00:00
                          subscribedIsExpiredNow: false
                          subscribedOnExpiredNow: false
                          subscribedByAutoprolong: true
                          privateArchivedPostsCount: 0
                          shouldShowFinishedStreams: false
                          isMarkdownDisabledForAbout: true
                          avatarHeaderConverterUpload: true
                    items:
                      type: object
                      properties:
                        canNotSendReason:
                          type: boolean
                          example: false
                        canSendMessage:
                          type: boolean
                          example: true
                        canGoToProfile:
                          type: boolean
                          example: true
                        unreadMessagesCount:
                          type: integer
                          example: 1
                        hasUnreadTips:
                          type: boolean
                          example: false
                        isMutedNotifications:
                          type: boolean
                          example: false
                        lastMessage:
                          type: object
                          properties:
                            responseType:
                              type: string
                              example: message
                            text:
                              type: string
                              example: <p>Message text</p>
                            giphyId:
                              type: string
                              example: null
                              nullable: true
                            lockedText:
                              type: boolean
                              example: false
                            isFree:
                              type: boolean
                              example: true
                            price:
                              type: integer
                              example: 0
                            isMediaReady:
                              type: boolean
                              example: true
                            mediaCount:
                              type: integer
                              example: 0
                            media:
                              type: array
                              example: []
                            previews:
                              type: array
                              example: []
                            isTip:
                              type: boolean
                              example: false
                            isReportedByMe:
                              type: boolean
                              example: false
                            isCouplePeopleMedia:
                              type: boolean
                              example: false
                            queueId:
                              type: integer
                              example: 123
                            isMarkdownDisabled:
                              type: boolean
                              example: true
                            fromUser:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                _view:
                                  type: string
                                  example: i
                            isFromQueue:
                              type: boolean
                              example: true
                            canUnsendQueue:
                              type: boolean
                              example: true
                            unsendSecondsQueue:
                              type: integer
                              example: 1000000
                            id:
                              type: integer
                              example: 123
                            isOpened:
                              type: boolean
                              example: false
                            isNew:
                              type: boolean
                              example: true
                            createdAt:
                              type: string
                              example: 2025-01-01T01:01:01+00:00
                            changedAt:
                              type: string
                              example: 2025-01-01T01:01:01+00:00
                            cancelSeconds:
                              type: integer
                              example: 86268
                            isLiked:
                              type: boolean
                              example: false
                            canPurchase:
                              type: boolean
                              example: false
                            canPurchaseReason:
                              type: string
                              example: free
                            canReport:
                              type: boolean
                              example: true
                            canBePinned:
                              type: boolean
                              example: true
                            isPinned:
                              type: boolean
                              example: false
                        lastReadMessageId:
                          type: integer
                          example: 0
                        hasPurchasedFeed:
                          type: boolean
                          example: false
                        countPinnedMessages:
                          type: integer
                          example: 0
                        fan:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            name:
                              type: string
                              example: Name
                            view:
                              type: string
                              example: f
                            about:
                              type: string
                              example: <p>About</p>
                            avatar:
                              type: string
                              example: https://public.onlyfans.com/files/.../avatar.jpg
                            header:
                              type: string
                              example: https://public.onlyfans.com/files/.../header.jpg
                            notice:
                              type: string
                              example: ""
                            canChat:
                              type: boolean
                              example: true
                            canEarn:
                              type: boolean
                              example: true
                            tipsMax:
                              type: integer
                              example: 200
                            tipsMin:
                              type: integer
                              example: 5
                            website:
                              type: string
                              example: null
                              nullable: true
                            hasLinks:
                              type: boolean
                              example: false
                            isFriend:
                              type: boolean
                              example: false
                            joinDate:
                              type: string
                              example: 2025-01-01T01:01:01+00:00
                            lastSeen:
                              type: string
                              example: 2025-01-01T01:01:01+00:00
                            location:
                              type: string
                              example: Location
                            username:
                              type: string
                              example: username
                            wishlist:
                              type: string
                              example: null
                              nullable: true
                            canReport:
                              type: boolean
                              example: true
                            hasLabels:
                              type: boolean
                              example: true
                            hasStream:
                              type: boolean
                              example: false
                            isBlocked:
                              type: boolean
                              example: false
                            hasFriends:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            headerSize:
                              type: object
                              properties:
                                width:
                                  type: integer
                                  example: 767
                                height:
                                  type: integer
                                  example: 1152
                            isVerified:
                              type: boolean
                              example: true
                            postsCount:
                              type: integer
                              example: 123
                            audiosCount:
                              type: integer
                              example: 0
                            canRestrict:
                              type: boolean
                              example: true
                            displayName:
                              type: string
                              example: ""
                            isPerformer:
                              type: boolean
                              example: true
                            listsStates:
                              type: array
                              example:
                                - id: following
                                  name: Following
                                  type: following
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                - id: fans
                                  name: Fans
                                  type: fans
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                - id: rebill_off
                                  name: Renew Off
                                  type: rebill_off
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: null
                                - id: rebill_on
                                  name: Renew On
                                  type: rebill_on
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                - id: recent
                                  name: Recent (last 24 hours)
                                  type: recent
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                - id: friends
                                  name: Friends
                                  type: friends
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                                - id: muted
                                  name: Muted
                                  type: muted
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                                - id: tagged
                                  name: Tagged
                                  type: tagged
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: following
                                  name:
                                    type: string
                                    example: Following
                                  type:
                                    type: string
                                    example: following
                                  hasUser:
                                    type: boolean
                                    example: true
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: ALREADY_EXISTS
                            mediasCount:
                              type: integer
                              example: 123
                            photosCount:
                              type: integer
                              example: 123
                            tipsEnabled:
                              type: boolean
                              example: true
                            videosCount:
                              type: integer
                              example: 123
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: https://thumbs.onlyfans.com/.../avatar.jpg
                                c144:
                                  type: string
                                  example: https://thumbs.onlyfans.com/.../avatar.jpg
                            canLookStory:
                              type: boolean
                              example: true
                            canTrialSend:
                              type: boolean
                              example: false
                            headerThumbs:
                              type: object
                              properties:
                                w480:
                                  type: string
                                  example: https://thumbs.onlyfans.com/.../header.jpg
                                w760:
                                  type: string
                                  example: https://thumbs.onlyfans.com/.../header.jpg
                            isRestricted:
                              type: boolean
                              example: false
                            subscribedBy:
                              type: boolean
                              example: true
                            subscribedOn:
                              type: boolean
                              example: true
                            canCreateTrial:
                              type: boolean
                              example: false
                            canPayInternal:
                              type: boolean
                              example: true
                            canUnsubscribe:
                              type: boolean
                              example: true
                            favoritedCount:
                              type: integer
                              example: 123
                            favoritesCount:
                              type: integer
                              example: 123
                            hasPinnedPosts:
                              type: boolean
                              example: false
                            isAdultContent:
                              type: boolean
                              example: false
                            showMediaCount:
                              type: boolean
                              example: true
                            subscribePrice:
                              type: integer
                              example: 0
                            canCommentStory:
                              type: boolean
                              example: true
                            hasSavedStreams:
                              type: boolean
                              example: false
                            isRealPerformer:
                              type: boolean
                              example: true
                            showPostsInFeed:
                              type: boolean
                              example: true
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsTextEnabled:
                              type: boolean
                              example: true
                            canAddSubscriber:
                              type: boolean
                              example: false
                            subscribedByData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                status:
                                  type: string
                                  example: null
                                  nullable: true
                                isMuted:
                                  type: boolean
                                  example: false
                                duration:
                                  type: string
                                  example: 22 days
                                newPrice:
                                  type: integer
                                  example: 0
                                expiredAt:
                                  type: string
                                  example: 2025-01-01T01:01:01+00:00
                                renewedAt:
                                  type: string
                                  example: 2025-01-01T01:01:01+00:00
                                subscribes:
                                  type: array
                                  example:
                                    - id: 123
                                      date: 2025-01-01T01:01:01+00:00
                                      type: regular
                                      price: 0
                                      action: subscribe
                                      userId: 123
                                      discount: 0
                                      duration: 123
                                      offerEnd: null
                                      earningId: 0
                                      isCurrent: true
                                      startDate: 2025-01-01T01:01:01+00:00
                                      cancelDate: null
                                      expireDate: 2025-01-01T01:01:01+00:00
                                      offerStart: null
                                      regularPrice: 0
                                      subscriberId: 123
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                        example: 123
                                      date:
                                        type: string
                                        example: 2025-01-01T01:01:01+00:00
                                      type:
                                        type: string
                                        example: regular
                                      price:
                                        type: integer
                                        example: 0
                                      action:
                                        type: string
                                        example: subscribe
                                      userId:
                                        type: integer
                                        example: 123
                                      discount:
                                        type: integer
                                        example: 0
                                      duration:
                                        type: integer
                                        example: 123
                                      offerEnd:
                                        type: string
                                        example: null
                                        nullable: true
                                      earningId:
                                        type: integer
                                        example: 0
                                      isCurrent:
                                        type: boolean
                                        example: true
                                      startDate:
                                        type: string
                                        example: 2025-01-01T01:01:01+00:00
                                      cancelDate:
                                        type: string
                                        example: null
                                        nullable: true
                                      expireDate:
                                        type: string
                                        example: 2025-01-01T01:01:01+00:00
                                      offerStart:
                                        type: string
                                        example: null
                                        nullable: true
                                      regularPrice:
                                        type: integer
                                        example: 0
                                      subscriberId:
                                        type: integer
                                        example: 123
                                subscribeAt:
                                  type: string
                                  example: 2025-01-01T01:01:01+00:00
                                regularPrice:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribePrice:
                                  type: integer
                                  example: 0
                                discountPercent:
                                  type: integer
                                  example: 0
                                showPostsInFeed:
                                  type: boolean
                                  example: true
                                discountStartedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                unsubscribeReason:
                                  type: string
                                  example: No reason given
                                discountFinishedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            subscribedOnData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                status:
                                  type: string
                                  example: null
                                  nullable: true
                                isMuted:
                                  type: boolean
                                  example: false
                                duration:
                                  type: string
                                  example: 22 days
                                newPrice:
                                  type: integer
                                  example: 0
                                tipsSumm:
                                  type: integer
                                  example: 0
                                expiredAt:
                                  type: string
                                  example: 2025-01-01T01:01:01+00:00
                                postsSumm:
                                  type: integer
                                  example: 0
                                renewedAt:
                                  type: string
                                  example: 2025-01-01T01:01:01+00:00
                                totalSumm:
                                  type: integer
                                  example: 0
                                subscribes:
                                  type: array
                                  example:
                                    - id: 123
                                      date: 2025-01-01T01:01:01+00:00
                                      type: auto
                                      price: 0
                                      action: subscribe
                                      userId: 123
                                      discount: 0
                                      duration: 123
                                      offerEnd: null
                                      earningId: 0
                                      isCurrent: true
                                      startDate: 2025-01-01T01:01:01+00:00
                                      cancelDate: null
                                      expireDate: 2025-01-01T01:01:01+00:00
                                      offerStart: null
                                      regularPrice: 0
                                      subscriberId: 123
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                        example: 123
                                      date:
                                        type: string
                                        example: 2025-01-01T01:01:01+00:00
                                      type:
                                        type: string
                                        example: auto
                                      price:
                                        type: integer
                                        example: 0
                                      action:
                                        type: string
                                        example: subscribe
                                      userId:
                                        type: integer
                                        example: 123
                                      discount:
                                        type: integer
                                        example: 0
                                      duration:
                                        type: integer
                                        example: 123
                                      offerEnd:
                                        type: string
                                        example: null
                                        nullable: true
                                      earningId:
                                        type: integer
                                        example: 0
                                      isCurrent:
                                        type: boolean
                                        example: true
                                      startDate:
                                        type: string
                                        example: 2025-01-01T01:01:01+00:00
                                      cancelDate:
                                        type: string
                                        example: null
                                        nullable: true
                                      expireDate:
                                        type: string
                                        example: 2025-01-01T01:01:01+00:00
                                      offerStart:
                                        type: string
                                        example: null
                                        nullable: true
                                      regularPrice:
                                        type: integer
                                        example: 0
                                      subscriberId:
                                        type: integer
                                        example: 123
                                streamsSumm:
                                  type: integer
                                  example: 0
                                subscribeAt:
                                  type: string
                                  example: 2025-01-01T01:01:01+00:00
                                messagesSumm:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: number
                                  example: 4.99
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribePrice:
                                  type: number
                                  example: 4.99
                                subscribesSumm:
                                  type: integer
                                  example: 0
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountStartedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                unsubscribeReason:
                                  type: string
                                  example: No reason given
                                discountFinishedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            subscribersCount:
                              type: string
                              example: null
                              nullable: true
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isPaywallRequired:
                              type: boolean
                              example: true
                            isReferrerAllowed:
                              type: boolean
                              example: true
                            isSpringConnected:
                              type: boolean
                              example: false
                            archivedPostsCount:
                              type: integer
                              example: 0
                            canCreatePromotion:
                              type: boolean
                              example: false
                            hasScheduledStream:
                              type: boolean
                              example: false
                            isSpotifyConnected:
                              type: boolean
                              example: false
                            subscribedByExpire:
                              type: boolean
                              example: false
                            finishedStreamsCount:
                              type: integer
                              example: 0
                            isPendingAutoprolong:
                              type: boolean
                              example: false
                            isPrivateRestriction:
                              type: boolean
                              example: false
                            showSubscribersCount:
                              type: boolean
                              example: false
                            subscribedOnDuration:
                              type: string
                              example: 22 days
                            canReceiveChatMessage:
                              type: boolean
                              example: true
                            currentSubscribePrice:
                              type: integer
                              example: 0
                            firstPublishedPostDate:
                              type: string
                              example: 2025-01-01T01:01:01+00:00
                            subscribedByExpireDate:
                              type: string
                              example: 2025-01-01T01:01:01+00:00
                            subscribedIsExpiredNow:
                              type: boolean
                              example: false
                            subscribedOnExpiredNow:
                              type: boolean
                              example: false
                            subscribedByAutoprolong:
                              type: boolean
                              example: true
                            privateArchivedPostsCount:
                              type: integer
                              example: 0
                            shouldShowFinishedStreams:
                              type: boolean
                              example: false
                            isMarkdownDisabledForAbout:
                              type: boolean
                              example: true
                            avatarHeaderConverterUpload:
                              type: boolean
                              example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: https://app.onlyfansapi.com/api/acct_XXXXXXXXXXX/chats?offset=10&limit=10
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49999
      tags:
        - Chats
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Mark All Chats as Read (/api-reference/chats/mark-all-chats-as-read)

Mark all chats as read.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/chats/mark-as-read
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/chats/mark-as-read:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Mark All Chats as Read
      operationId: markAllChatsAsRead
      description: Mark all chats as read.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999884
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49971
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999884
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49971
      tags:
        - Chats
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Mark Chat as Read (/api-reference/chats/mark-chat-as-read)

Mark a specific chat as read. Alternative to List Chat Messages endpoint, if you just want to mark the chat as read without fetching messages.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/chats/{chat_id}/mark-as-read
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/chats/{chat_id}/mark-as-read:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The ID of the chat to mark as read, usually a fan's OnlyFans User ID
        example: "123"
        required: true
        schema:
          type: string
    post:
      summary: Mark Chat as Read
      operationId: markChatAsRead
      description: Mark a specific chat as read. Alternative to List Chat Messages
        endpoint, if you just want to mark the chat as read without fetching
        messages.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999884
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49971
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999884
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49971
      tags:
        - Chats
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Mark Chat as Unread (/api-reference/chats/mark-chat-as-unread)

Mark a specific chat as unread.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/chats/{chat_id}/mark-as-unread
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/chats/{chat_id}/mark-as-unread:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The ID of the chat to mark as read, usually a fan's OnlyFans User ID
        example: "123"
        required: true
        schema:
          type: string
    post:
      summary: Mark Chat as Unread
      operationId: markChatAsUnread
      description: Mark a specific chat as unread.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 9998195
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4995
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 9998195
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4995
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Chats
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Mute Chat Notifications (/api-reference/chats/mute-chat-notifications)

Mute notifications for a specific chat.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/chats/{chat_id}/mute
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/chats/{chat_id}/mute:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The ID of the chat to mute, usually a fan's OnlyFans User ID
        example: "123"
        required: true
        schema:
          type: string
    post:
      summary: Mute Chat Notifications
      operationId: muteChatNotifications
      description: Mute notifications for a specific chat.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999964347
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49987
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999964347
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49987
      tags:
        - Chats
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Start Typing Indicator (/api-reference/chats/start-typing-indicator)

Calling this endpoint will show the target fan a "Model is typing..." note in the chat for \~4 seconds. Duplicate calls for the same account and chat are coalesced during that window.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/chats/{chat_id}/typing
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/chats/{chat_id}/typing:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The ID of the chat (usually a fan's OnlyFans User ID)
        example: "123"
        required: true
        schema:
          type: string
    post:
      summary: Start Typing Indicator
      operationId: startTypingIndicator
      description: Calling this endpoint will show the target fan a "Model is
        typing..." note in the chat for ~4 seconds. Duplicate calls for the same
        account and chat are coalesced during that window.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 0
                      balance: 224884
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49958
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 224884
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49958
      tags:
        - Chats
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Unmute Chat Notifications (/api-reference/chats/unmute-chat-notifications)

Unmute notifications for a specific chat.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/chats/{chat_id}/unmute
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/chats/{chat_id}/unmute:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The ID of the chat to unmute, usually a fan's OnlyFans User ID
        example: "123"
        required: true
        schema:
          type: string
    delete:
      summary: Unmute Chat Notifications
      operationId: unmuteChatNotifications
      description: Unmute notifications for a specific chat.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999957
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4997
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999957
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4997
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Chats
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Attach Tags (Release Forms) to Message (/api-reference/chat-messages/attach-tags-release-forms-to-message)

Attach Tags (Release Forms) to a message that has already been sent. Please note, that this is a "sync" operation - for example, if you provide empty `rfTag` it will remove all existing tags already attached to the message.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/messages/{queue_id}/attach-tags
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/messages/{queue_id}/attach-tags:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: queue_id
        description: The message's `queueId` (NOT its `id`). Every message in the List
          Chat Messages response exposes both an `id` and a `queueId` - this
          endpoint requires the `queueId`. Must be a message sent by the
          creator. Passing the message `id` instead returns a 400 "Entity type
          is not allowed or not exists" from OnlyFans.
        example: "40627236721"
        required: true
        schema:
          type: string
    post:
      summary: Attach Tags (Release Forms) to Message
      operationId: attachTagsReleaseFormsToMessage
      description: Attach Tags (Release Forms) to a message that has already been
        sent. Please note, that this is a "sync" operation - for example, if you
        provide empty `rfTag` it will remove all existing tags already attached
        to the message.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 9976
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49990
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 9976
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49990
      tags:
        - Chat Messages
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                rfTag:
                  type: string
                  description: Array of OnlyFans Creator User IDs to tag in your message
                  example: null
                rfPartner:
                  type: string
                  description: Array of OnlyFans Release Form Partners IDs to tag in your message
                  example: null
                rfGuest:
                  type: string
                  description: Array of OnlyFans Release Form Guest IDs to tag in your message
                  example: null
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Delete Message (/api-reference/chat-messages/delete-message)

Delete a message from a chat. Please note that ONLY messages sent less than 24 hours ago can be deleted.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/chats/{chat_id}/messages/{message_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/chats/{chat_id}/messages/{message_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The ID of the chat (usually a fan's OnlyFans User ID)
        example: "123"
        required: true
        schema:
          type: string
      - in: path
        name: message_id
        description: The ID of the message to retrieve
        example: "69696969"
        required: true
        schema:
          type: string
    delete:
      summary: Delete Message
      operationId: deleteMessage
      description: Delete a message from a chat. Please note that ONLY messages sent
        less than 24 hours ago can be deleted.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 9976
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49990
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 9976
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49990
      tags:
        - Chat Messages
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Specific Chat Message (/api-reference/chat-messages/get-specific-chat-message)

Get a single chat message by its ID. Returns a 404 if the message does not exist in the chat.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/chats/{chat_id}/messages/{message_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/chats/{chat_id}/messages/{message_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The ID of the chat (usually a fan's OnlyFans User ID)
        example: "123"
        required: true
        schema:
          type: string
      - in: path
        name: message_id
        description: The ID of the message to retrieve
        example: "69696969"
        required: true
        schema:
          type: string
    get:
      summary: Get Specific Chat Message
      operationId: getSpecificChatMessage
      description: Get a single chat message by its ID. Returns a 404 if the message
        does not exist in the chat.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    responseType: message
                    text: I am so glad you’re here🫶🏻
                    giphyId: null
                    lockedText: false
                    isFree: true
                    price: 0
                    isMediaReady: true
                    mediaCount: 0
                    media: []
                    previews: []
                    isTip: false
                    isReportedByMe: false
                    isCouplePeopleMedia: false
                    queueId: 123
                    isMarkdownDisabled: true
                    releaseForms: []
                    fromUser:
                      id: 123
                      _view: s
                    isFromQueue: false
                    id: 69696969
                    isOpened: false
                    isNew: false
                    createdAt: 2025-02-03T23:29:53+00:00
                    changedAt: 2025-02-03T23:29:53+00:00
                    cancelSeconds: 0
                    isLiked: false
                    canPurchase: false
                    canPurchaseReason: free
                    canReport: false
                    canBePinned: true
                    isPinned: false
                    isSentByMe: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999964357
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 997
                      remaining_day: 49997
                properties:
                  data:
                    type: object
                    properties:
                      responseType:
                        type: string
                        example: message
                      text:
                        type: string
                        example: I am so glad you’re here🫶🏻
                      giphyId:
                        type: string
                        example: null
                        nullable: true
                      lockedText:
                        type: boolean
                        example: false
                      isFree:
                        type: boolean
                        example: true
                      price:
                        type: integer
                        example: 0
                      isMediaReady:
                        type: boolean
                        example: true
                      mediaCount:
                        type: integer
                        example: 0
                      media:
                        type: array
                        example: []
                      previews:
                        type: array
                        example: []
                      isTip:
                        type: boolean
                        example: false
                      isReportedByMe:
                        type: boolean
                        example: false
                      isCouplePeopleMedia:
                        type: boolean
                        example: false
                      queueId:
                        type: integer
                        example: 123
                      isMarkdownDisabled:
                        type: boolean
                        example: true
                      releaseForms:
                        type: array
                        example: []
                      fromUser:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 123
                          _view:
                            type: string
                            example: s
                      isFromQueue:
                        type: boolean
                        example: false
                      id:
                        type: integer
                        example: 69696969
                      isOpened:
                        type: boolean
                        example: false
                      isNew:
                        type: boolean
                        example: false
                      createdAt:
                        type: string
                        example: 2025-02-03T23:29:53+00:00
                      changedAt:
                        type: string
                        example: 2025-02-03T23:29:53+00:00
                      cancelSeconds:
                        type: integer
                        example: 0
                      isLiked:
                        type: boolean
                        example: false
                      canPurchase:
                        type: boolean
                        example: false
                      canPurchaseReason:
                        type: string
                        example: free
                      canReport:
                        type: boolean
                        example: false
                      canBePinned:
                        type: boolean
                        example: true
                      isPinned:
                        type: boolean
                        example: false
                      isSentByMe:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999964357
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 49997
        "404":
          description: Message Not Found
          content:
            application/json:
              schema:
                type: object
                example:
                  error: ONLYFANS_COM_ERROR
                  message: The requested OnlyFans resource was not found.
                  description: This error happened while our servers tried to communicate with
                    OnlyFans.com in real time
                  onlyfans_response:
                    status: 200
                    body:
                      list: []
                      hasMore: false
                properties:
                  error:
                    type: string
                    example: ONLYFANS_COM_ERROR
                  message:
                    type: string
                    example: The requested OnlyFans resource was not found.
                  description:
                    type: string
                    example: This error happened while our servers tried to communicate with
                      OnlyFans.com in real time
                  onlyfans_response:
                    type: object
                    properties:
                      status:
                        type: integer
                        example: 200
                      body:
                        type: object
                        properties:
                          list:
                            type: array
                            example: []
                          hasMore:
                            type: boolean
                            example: false
      tags:
        - Chat Messages
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Like Message (/api-reference/chat-messages/like-message)

Like a chat message.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/chats/{chat_id}/messages/{message_id}/like
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/chats/{chat_id}/messages/{message_id}/like:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The ID of the chat, usually a fan's OnlyFans User ID
        example: "123"
        required: true
        schema:
          type: string
      - in: path
        name: message_id
        description: The ID of the message to like
        example: "123456789"
        required: true
        schema:
          type: string
    post:
      summary: Like Message
      operationId: likeMessage
      description: Like a chat message.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                    isLiked: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999964351
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49991
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                      isLiked:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999964351
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49991
      tags:
        - Chat Messages
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Chat Messages (/api-reference/chat-messages/list-chat-messages)

Get messages from a specific chat.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/chats/{chat_id}/messages
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/chats/{chat_id}/messages:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The ID of the chat (usually a fan's OnlyFans User ID)
        example: "123"
        required: true
        schema:
          type: string
    get:
      summary: List Chat Messages
      operationId: listChatMessages
      description: Get messages from a specific chat.
      parameters:
        - in: query
          name: limit
          description: The number of messages to return (default = 10, max = 100)
          example: 10
          required: false
          schema:
            type: string
            description: The number of messages to return (default = 10, max = 100)
            example: 10
        - in: query
          name: filter
          description: Filter by certain messages. Currently, only pins are filterable.
          example: pinned
          required: false
          schema:
            type: string
            description: Filter by certain messages. Currently, only pins are filterable.
            example: pinned
            enum:
              - pinned
        - in: query
          name: first_id
          description: Use for pagination when `order=desc` (newest to oldest). Include
            this message ID as the first message in the results. Used to
            retrieve messages from e.g. the Search Chat Messages endpoint IDs.
          example: 123
          required: false
          schema:
            type: string
            description: Use for pagination when `order=desc` (newest to oldest). Include
              this message ID as the first message in the results. Used to
              retrieve messages from e.g. the Search Chat Messages endpoint IDs.
            example: 123
            nullable: true
        - in: query
          name: last_id
          description: Use for pagination when `order=asc` (oldest to newest). Include
            this message ID as the first message in the results. WARNING! The
            response list of messages will also be inverted (oldest messages
            will be first, opposite to default where `order=desc`).
          example: 123
          required: false
          schema:
            type: string
            description: Use for pagination when `order=asc` (oldest to newest). Include
              this message ID as the first message in the results. WARNING! The
              response list of messages will also be inverted (oldest messages
              will be first, opposite to default where `order=desc`).
            example: 123
            nullable: true
        - in: query
          name: order
          description: Sort order for messages (desc or asc)
          example: desc
          required: false
          schema:
            type: string
            description: Sort order for messages (desc or asc)
            example: desc
        - in: query
          name: skip_users
          description: Whether to skip user details (`all` or `none`).
          example: all
          required: false
          schema:
            type: string
            description: Whether to skip user details (`all` or `none`).
            example: all
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - responseType: message
                      text: <p>yes lets do it</p>
                      giphyId: null
                      lockedText: false
                      isFree: true
                      price: 0
                      isMediaReady: true
                      mediaCount: 0
                      media: []
                      previews: []
                      isTip: false
                      isReportedByMe: false
                      isCouplePeopleMedia: false
                      queueId: 12345678901
                      isMarkdownDisabled: true
                      releaseForms: []
                      fromUser:
                        id: 987654321
                        _view: s
                      isFromQueue: false
                      id: 1234567890123
                      isOpened: false
                      isNew: true
                      createdAt: 2025-09-02T21:02:18+00:00
                      changedAt: 2025-09-02T21:02:18+00:00
                      cancelSeconds: 86396
                      isLiked: false
                      canPurchase: false
                      canPurchaseReason: free
                      canReport: false
                      canBePinned: true
                      isPinned: false
                      isSentByMe: true
                    - responseType: message
                      text: <p>Are you ready for video call now ? </p>
                      giphyId: null
                      lockedText: false
                      isFree: true
                      price: 0
                      isMediaReady: true
                      mediaCount: 1
                      media:
                        - id: 9876543210
                          type: video
                          convertedToVideo: false
                          canView: true
                          hasError: false
                          createdAt: null
                          isReady: true
                          files:
                            full:
                              url: null
                              width: 480
                              height: 848
                              size: 0
                              sources: []
                            thumb:
                              url: https://cdn2.onlyfans.com/files/ANONYMIZED_PATH/300x300_ANONYMIZED_FILENAME.jpg?Tag=2&u=987654321&Policy=ANONYMIZED_POLICY&Signature=ANONYMIZED_SIGNATURE&Key-Pair-Id=ANONYMIZED_KEY_PAIR_ID
                              width: 300
                              height: 300
                              size: 0
                            preview:
                              url: https://cdn2.onlyfans.com/files/ANONYMIZED_PATH/480x848_ANONYMIZED_FILENAME.jpg?Tag=2&u=987654321&Policy=ANONYMIZED_POLICY&Signature=ANONYMIZED_SIGNATURE&Key-Pair-Id=ANONYMIZED_KEY_PAIR_ID
                              width: 480
                              height: 848
                              size: 0
                            squarePreview:
                              url: https://cdn2.onlyfans.com/files/ANONYMIZED_PATH/960x960_ANONYMIZED_FILENAME.jpg?Tag=2&u=987654321&Policy=ANONYMIZED_POLICY&Signature=ANONYMIZED_SIGNATURE&Key-Pair-Id=ANONYMIZED_KEY_PAIR_ID
                              width: 960
                              height: 960
                              size: 0
                            drm:
                              manifest:
                                hls: https://cdn3.onlyfans.com/hls/files/ANONYMIZED_PATH/ANONYMIZED_FILENAME.m3u8
                                dash: https://cdn3.onlyfans.com/dash/files/ANONYMIZED_PATH/ANONYMIZED_FILENAME.mpd
                              signature:
                                hls:
                                  CloudFront-Policy: ANONYMIZED_CLOUDFRONT_POLICY
                                  CloudFront-Signature: ANONYMIZED_CLOUDFRONT_SIGNATURE
                                  CloudFront-Key-Pair-Id: ANONYMIZED_CLOUDFRONT_KEY_PAIR_ID
                                dash:
                                  CloudFront-Policy: ANONYMIZED_CLOUDFRONT_POLICY
                                  CloudFront-Signature: ANONYMIZED_CLOUDFRONT_SIGNATURE
                                  CloudFront-Key-Pair-Id: ANONYMIZED_CLOUDFRONT_KEY_PAIR_ID
                          duration: 9
                          hasCustomPreview: false
                          videoSources:
                            "240": null
                            "720": null
                      previews: []
                      isTip: false
                      isReportedByMe: false
                      isCouplePeopleMedia: false
                      queueId: 12345678902
                      isMarkdownDisabled: true
                      fromUser:
                        id: 123456789
                        _view: s
                      isFromQueue: true
                      canUnsendQueue: true
                      unsendSecondsQueue: 1000000
                      id: 1234567890124
                      isOpened: false
                      isNew: false
                      createdAt: 2025-09-02T20:35:13+00:00
                      changedAt: 2025-09-02T20:35:13+00:00
                      cancelSeconds: 85047
                      isLiked: false
                      canPurchase: false
                      canPurchaseReason: free
                      canReport: true
                      canBePinned: true
                      isPinned: false
                      isSentByMe: false
                  _pagination:
                    next_page: https://app.onlyfansapi.com/api/acct_ANONYMIZED_ACCOUNT_ID/chats/987654321/messages?order=desc&skip_users=all&id=1234567890125
                  _meta:
                    _credits:
                      used: 1
                      balance: 224891
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49984
                properties:
                  data:
                    type: array
                    example:
                      - responseType: message
                        text: <p>yes lets do it</p>
                        giphyId: null
                        lockedText: false
                        isFree: true
                        price: 0
                        isMediaReady: true
                        mediaCount: 0
                        media: []
                        previews: []
                        isTip: false
                        isReportedByMe: false
                        isCouplePeopleMedia: false
                        queueId: 12345678901
                        isMarkdownDisabled: true
                        releaseForms: []
                        fromUser:
                          id: 987654321
                          _view: s
                        isFromQueue: false
                        id: 1234567890123
                        isOpened: false
                        isNew: true
                        createdAt: 2025-09-02T21:02:18+00:00
                        changedAt: 2025-09-02T21:02:18+00:00
                        cancelSeconds: 86396
                        isLiked: false
                        canPurchase: false
                        canPurchaseReason: free
                        canReport: false
                        canBePinned: true
                        isPinned: false
                        isSentByMe: true
                      - responseType: message
                        text: <p>Are you ready for video call now ? </p>
                        giphyId: null
                        lockedText: false
                        isFree: true
                        price: 0
                        isMediaReady: true
                        mediaCount: 1
                        media:
                          - id: 9876543210
                            type: video
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: null
                            isReady: true
                            files:
                              full:
                                url: null
                                width: 480
                                height: 848
                                size: 0
                                sources: []
                              thumb:
                                url: https://cdn2.onlyfans.com/files/ANONYMIZED_PATH/300x300_ANONYMIZED_FILENAME.jpg?Tag=2&u=987654321&Policy=ANONYMIZED_POLICY&Signature=ANONYMIZED_SIGNATURE&Key-Pair-Id=ANONYMIZED_KEY_PAIR_ID
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: https://cdn2.onlyfans.com/files/ANONYMIZED_PATH/480x848_ANONYMIZED_FILENAME.jpg?Tag=2&u=987654321&Policy=ANONYMIZED_POLICY&Signature=ANONYMIZED_SIGNATURE&Key-Pair-Id=ANONYMIZED_KEY_PAIR_ID
                                width: 480
                                height: 848
                                size: 0
                              squarePreview:
                                url: https://cdn2.onlyfans.com/files/ANONYMIZED_PATH/960x960_ANONYMIZED_FILENAME.jpg?Tag=2&u=987654321&Policy=ANONYMIZED_POLICY&Signature=ANONYMIZED_SIGNATURE&Key-Pair-Id=ANONYMIZED_KEY_PAIR_ID
                                width: 960
                                height: 960
                                size: 0
                              drm:
                                manifest:
                                  hls: https://cdn3.onlyfans.com/hls/files/ANONYMIZED_PATH/ANONYMIZED_FILENAME.m3u8
                                  dash: https://cdn3.onlyfans.com/dash/files/ANONYMIZED_PATH/ANONYMIZED_FILENAME.mpd
                                signature:
                                  hls:
                                    CloudFront-Policy: ANONYMIZED_CLOUDFRONT_POLICY
                                    CloudFront-Signature: ANONYMIZED_CLOUDFRONT_SIGNATURE
                                    CloudFront-Key-Pair-Id: ANONYMIZED_CLOUDFRONT_KEY_PAIR_ID
                                  dash:
                                    CloudFront-Policy: ANONYMIZED_CLOUDFRONT_POLICY
                                    CloudFront-Signature: ANONYMIZED_CLOUDFRONT_SIGNATURE
                                    CloudFront-Key-Pair-Id: ANONYMIZED_CLOUDFRONT_KEY_PAIR_ID
                            duration: 9
                            hasCustomPreview: false
                            videoSources:
                              "240": null
                              "720": null
                        previews: []
                        isTip: false
                        isReportedByMe: false
                        isCouplePeopleMedia: false
                        queueId: 12345678902
                        isMarkdownDisabled: true
                        fromUser:
                          id: 123456789
                          _view: s
                        isFromQueue: true
                        canUnsendQueue: true
                        unsendSecondsQueue: 1000000
                        id: 1234567890124
                        isOpened: false
                        isNew: false
                        createdAt: 2025-09-02T20:35:13+00:00
                        changedAt: 2025-09-02T20:35:13+00:00
                        cancelSeconds: 85047
                        isLiked: false
                        canPurchase: false
                        canPurchaseReason: free
                        canReport: true
                        canBePinned: true
                        isPinned: false
                        isSentByMe: false
                    items:
                      type: object
                      properties:
                        responseType:
                          type: string
                          example: message
                        text:
                          type: string
                          example: <p>yes lets do it</p>
                        giphyId:
                          type: string
                          example: null
                          nullable: true
                        lockedText:
                          type: boolean
                          example: false
                        isFree:
                          type: boolean
                          example: true
                        price:
                          type: integer
                          example: 0
                        isMediaReady:
                          type: boolean
                          example: true
                        mediaCount:
                          type: integer
                          example: 0
                        media:
                          type: array
                          example: []
                        previews:
                          type: array
                          example: []
                        isTip:
                          type: boolean
                          example: false
                        isReportedByMe:
                          type: boolean
                          example: false
                        isCouplePeopleMedia:
                          type: boolean
                          example: false
                        queueId:
                          type: integer
                          example: 12345678901
                        isMarkdownDisabled:
                          type: boolean
                          example: true
                        releaseForms:
                          type: array
                          example: []
                        fromUser:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 987654321
                            _view:
                              type: string
                              example: s
                        isFromQueue:
                          type: boolean
                          example: false
                        id:
                          type: integer
                          example: 1234567890123
                        isOpened:
                          type: boolean
                          example: false
                        isNew:
                          type: boolean
                          example: true
                        createdAt:
                          type: string
                          example: 2025-09-02T21:02:18+00:00
                        changedAt:
                          type: string
                          example: 2025-09-02T21:02:18+00:00
                        cancelSeconds:
                          type: integer
                          example: 86396
                        isLiked:
                          type: boolean
                          example: false
                        canPurchase:
                          type: boolean
                          example: false
                        canPurchaseReason:
                          type: string
                          example: free
                        canReport:
                          type: boolean
                          example: false
                        canBePinned:
                          type: boolean
                          example: true
                        isPinned:
                          type: boolean
                          example: false
                        isSentByMe:
                          type: boolean
                          example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: https://app.onlyfansapi.com/api/acct_ANONYMIZED_ACCOUNT_ID/chats/987654321/messages?order=desc&skip_users=all&id=1234567890125
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 224891
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49984
      tags:
        - Chat Messages
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Pin Message (/api-reference/chat-messages/pin-message)

Pin a message from a chat.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/chats/{chat_id}/messages/{message_id}/pin
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/chats/{chat_id}/messages/{message_id}/pin:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The ID of the chat, usually a fan's OnlyFans User ID
        example: "123"
        required: true
        schema:
          type: string
      - in: path
        name: message_id
        description: The ID of the message to pin
        example: "123456789"
        required: true
        schema:
          type: string
    post:
      summary: Pin Message
      operationId: pinMessage
      description: Pin a message from a chat.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999964357
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 997
                      remaining_day: 49997
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999964357
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 49997
      tags:
        - Chat Messages
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Search Chat Messages (/api-reference/chat-messages/search-chat-messages)

Search messages in a specific chat. Returns a list of message IDs matching the search query.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/chats/{chat_id}/messages/search
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/chats/{chat_id}/messages/search:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The ID of the chat (usually a fan's OnlyFans User ID)
        example: "123"
        required: true
        schema:
          type: string
    get:
      summary: Search Chat Messages
      operationId: searchChatMessages
      description: Search messages in a specific chat. Returns a list of message IDs
        matching the search query.
      parameters:
        - in: query
          name: query
          description: The query search in messages.
          example: Hello
          required: true
          schema:
            type: string
            description: The query search in messages.
            example: Hello
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - 123
                    - 456
                    - 789
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999892
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49979
                properties:
                  data:
                    type: array
                    example:
                      - 123
                      - 456
                      - 789
                    items:
                      type: integer
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999892
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49979
      tags:
        - Chat Messages
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Send Message (/api-reference/chat-messages/send-message)

Send a new message to a chat.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/chats/{chat_id}/messages
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/chats/{chat_id}/messages:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The ID of the chat (usually a fan's OnlyFans User ID)
        example: "123"
        required: true
        schema:
          type: string
    post:
      summary: Send Message
      operationId: sendMessage
      description: Send a new message to a chat.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    responseType: message
                    text: <p>Message text</p>
                    giphyId: null
                    lockedText: true
                    isFree: true
                    price: 0
                    isMediaReady: true
                    mediaCount: 0
                    media: []
                    previews: []
                    isTip: false
                    isReportedByMe: false
                    isCouplePeopleMedia: false
                    queueId: 123
                    isMarkdownDisabled: true
                    releaseForms: []
                    fromUser:
                      id: 339543013
                      _view: s
                    isFromQueue: false
                    id: 123
                    isOpened: false
                    isNew: true
                    createdAt: 2025-02-03T23:29:53+00:00
                    changedAt: 2025-02-03T23:29:53+00:00
                    cancelSeconds: 119
                    isLiked: false
                    canPurchase: false
                    canPurchaseReason: free
                    canReport: false
                    canBePinned: true
                    isPinned: false
                  _pagination:
                    next_page: https://app.onlyfansapi.com/api/acct_XXXXXXXXXXX/chats/XXXXXXXXX/messages?limit=10&id=XXXXXXXXX
                  _meta:
                    _credits:
                      used: 1
                      balance: 1
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49999
                properties:
                  data:
                    type: object
                    properties:
                      responseType:
                        type: string
                        example: message
                      text:
                        type: string
                        example: <p>Message text</p>
                      giphyId:
                        type: string
                        example: null
                        nullable: true
                      lockedText:
                        type: boolean
                        example: true
                      isFree:
                        type: boolean
                        example: true
                      price:
                        type: integer
                        example: 0
                      isMediaReady:
                        type: boolean
                        example: true
                      mediaCount:
                        type: integer
                        example: 0
                      media:
                        type: array
                        example: []
                      previews:
                        type: array
                        example: []
                      isTip:
                        type: boolean
                        example: false
                      isReportedByMe:
                        type: boolean
                        example: false
                      isCouplePeopleMedia:
                        type: boolean
                        example: false
                      queueId:
                        type: integer
                        example: 123
                      isMarkdownDisabled:
                        type: boolean
                        example: true
                      releaseForms:
                        type: array
                        example: []
                      fromUser:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 339543013
                          _view:
                            type: string
                            example: s
                      isFromQueue:
                        type: boolean
                        example: false
                      id:
                        type: integer
                        example: 123
                      isOpened:
                        type: boolean
                        example: false
                      isNew:
                        type: boolean
                        example: true
                      createdAt:
                        type: string
                        example: 2025-02-03T23:29:53+00:00
                      changedAt:
                        type: string
                        example: 2025-02-03T23:29:53+00:00
                      cancelSeconds:
                        type: integer
                        example: 119
                      isLiked:
                        type: boolean
                        example: false
                      canPurchase:
                        type: boolean
                        example: false
                      canPurchaseReason:
                        type: string
                        example: free
                      canReport:
                        type: boolean
                        example: false
                      canBePinned:
                        type: boolean
                        example: true
                      isPinned:
                        type: boolean
                        example: false
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: https://app.onlyfansapi.com/api/acct_XXXXXXXXXXX/chats/XXXXXXXXX/messages?limit=10&id=XXXXXXXXX
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49999
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                type: object
                example:
                  error: VALIDATION_ERROR
                  message: The text field is required.
                  description: The request parameters failed validation.
                  errors:
                    text:
                      - The text field is required.
                  _meta:
                    _credits:
                      used: 0
                      balance: 9554
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49999
                properties:
                  error:
                    type: string
                    example: VALIDATION_ERROR
                  message:
                    type: string
                    example: The text field is required.
                  description:
                    type: string
                    example: The request parameters failed validation.
                  errors:
                    type: object
                    properties:
                      text:
                        type: array
                        example:
                          - The text field is required.
                        items:
                          type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9554
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49999
      tags:
        - Chat Messages
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: The message text content. Required unless a media file is present.
                  example: Hello!
                replyToMessageId:
                  type: integer
                  description: Mark this message as a reply to another (can be either your own, or
                    the recipient's)
                  example: 123456789
                lockedText:
                  type: boolean
                  description: Whether the text should be shown or hidden
                  example: true
                price:
                  type: integer
                  description: Price for paid content (0 or between 3-200). In case this is not
                    zero, **mediaFiles** is required
                  example: 10
                mediaFiles:
                  type: array
                  description: Direct file uploads, OFAPI `ofapi_media_` IDs, or OF vault IDs.
                    Will be hidden if `price` is provided.
                  example:
                    - ofapi_media_abc123
                    - 1234567890
                  items:
                    type: file[]|string
                previews:
                  type: array
                  description: Direct file uploads, OFAPI `ofapi_media_` IDs, OF vault IDs, or
                    integer indices referencing uploaded files in `mediaFiles`.
                    Will be shown if `price` is provided.
                  example:
                    - ofapi_media_abc123
                    - 1234567890
                  items:
                    type: file[]|string[]|int
                giphyId:
                  type: string
                  description: The ID of the Giphy GIF to attach to the message. Get IDs from the
                    Giphy listing endpoints (`/giphy/trending`,
                    `/giphy/search`).
                  example: WAGC3LeqJvXglm5H7a
                rfTag:
                  type: string
                  description: Array of OnlyFans Creator User IDs to tag in your message
                  example: null
                rfPartner:
                  type: string
                  description: Array of OnlyFans Release Form Partners IDs to tag in your message
                  example: null
                rfGuest:
                  type: string
                  description: Array of OnlyFans Release Form Guest IDs to tag in your message
                  example: null
                blockBannedWords:
                  type: string
                  description: Screen `text` for OnlyFans banned words and block the send if any
                    are found (returns a 422 listing the offending words).
                    `strict_ban` blocks all tiers, `risky` blocks Risky +
                    Replace/soften, `replace_soften` blocks Replace/soften only.
                    Omit to disable screening.
                  example: strict_ban
                  enum:
                    - strict_ban
                    - risky
                    - replace_soften
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Unlike Message (/api-reference/chat-messages/unlike-message)

Unlike a chat message.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/chats/{chat_id}/messages/{message_id}/unlike
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/chats/{chat_id}/messages/{message_id}/unlike:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The ID of the chat, usually a fan's OnlyFans User ID
        example: "123"
        required: true
        schema:
          type: string
      - in: path
        name: message_id
        description: The ID of the message to unlike
        example: "123456789"
        required: true
        schema:
          type: string
    delete:
      summary: Unlike Message
      operationId: unlikeMessage
      description: Unlike a chat message.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                    isLiked: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999964348
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49988
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                      isLiked:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999964348
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49988
      tags:
        - Chat Messages
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Unpin Message (/api-reference/chat-messages/unpin-message)

Unpin a message from a chat.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/chats/{chat_id}/messages/{message_id}/unpin
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/chats/{chat_id}/messages/{message_id}/unpin:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: chat_id
        description: The ID of the chat, usually a fan's OnlyFans User ID
        example: "123"
        required: true
        schema:
          type: string
      - in: path
        name: message_id
        description: The ID of the message to unpin
        example: "123456789"
        required: true
        schema:
          type: string
    delete:
      summary: Unpin Message
      operationId: unpinMessage
      description: Unpin a message from a chat.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999964356
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49996
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999964356
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49996
      tags:
        - Chat Messages
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Cancel Data Export (/api-reference/data-exports/cancel-data-export)

Cancel a running data export. Only exports with status `pending` or `in_progress` can be cancelled.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/data-exports/{data_export_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/data-exports/{data_export_id}:
    parameters:
      - in: path
        name: data_export_id
        description: The prefixed ID of the data export
        example: data_export_abc123
        required: true
        schema:
          type: string
    delete:
      summary: Cancel Data Export
      operationId: cancelDataExport
      description: Cancel a running data export. Only exports with status `pending` or
        `in_progress` can be cancelled.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: data_export_abc123xyz789
                    status: cancelled
                    message: Data export has been cancelled.
                  _meta:
                    _credits:
                      used: 0
                      balance: 9500
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4998
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: data_export_abc123xyz789
                      status:
                        type: string
                        example: cancelled
                      message:
                        type: string
                        example: Data export has been cancelled.
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9500
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4998
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Data Exports
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Create Data Export (/api-reference/data-exports/create-data-export)

Create a new data export request. This will calculate the required credits and prepare the export for starting.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/data-exports
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/data-exports:
    post:
      summary: Create Data Export
      operationId: createDataExport
      description: Create a new data export request. This will calculate the required
        credits and prepare the export for starting.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: data_export_abc123xyz789
                    type: chat_messages
                    status: calculating_credits
                    start_date: 2024-01-01T00:00:00+00:00
                    end_date: 2024-12-31T23:59:59+00:00
                    file_type: csv
                    created_at: 2024-12-02T12:00:00+00:00
                    requires_scraping: true
                    credit_calculation_note: This export type requires data scraping. Credits will
                      be calculated and charged after scraping completes.
                  _meta:
                    _credits:
                      used: 0
                      balance: 9500
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 60
                      limit_day: null
                      remaining_minute: 56
                      remaining_day: null
                      notice: ""
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: data_export_abc123xyz789
                      type:
                        type: string
                        example: chat_messages
                      status:
                        type: string
                        example: calculating_credits
                      start_date:
                        type: string
                        example: 2024-01-01T00:00:00+00:00
                      end_date:
                        type: string
                        example: 2024-12-31T23:59:59+00:00
                      file_type:
                        type: string
                        example: csv
                      created_at:
                        type: string
                        example: 2024-12-02T12:00:00+00:00
                      requires_scraping:
                        type: boolean
                        example: true
                      credit_calculation_note:
                        type: string
                        example: This export type requires data scraping. Credits will be calculated and
                          charged after scraping completes.
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9500
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 60
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 56
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: ""
      tags:
        - Data Exports
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  description: The type of data to export
                  example: transactions
                  enum:
                    - transactions
                    - chat_messages
                    - media_vault
                    - trial_links
                    - tracking_links
                    - smart_links
                    - payouts
                    - chargebacks
                    - public_profiles
                    - fans
                    - followings
                account_ids:
                  type: array
                  description: Array of account prefixed IDs to export data from. Not required for
                    `public_profiles` type.
                  example:
                    - acc_abc123
                    - acc_def456
                  items:
                    type: string
                start_date:
                  type: string
                  description: The start date for the export (ISO 8601 format).
                  example: 2024-01-01T00:00:00Z
                end_date:
                  type: string
                  description: The end date for the export (ISO 8601 format).
                  example: 2024-12-31T23:59:59Z
                export_columns:
                  type: array
                  description: Array of column names to include in the export (optional, defaults
                    to all columns for the export type)
                  example:
                    - transaction_id
                    - amount
                    - created_at
                  items:
                    type: string
                file_type:
                  type: string
                  description: "The output file format. Supported formats vary by export type:
                    `csv` or `xlsx` for transactions, chat_messages,
                    trial_links, tracking_links, smart_links, payouts,
                    chargebacks, public_profiles, fans, followings; `zip` for
                    media_vault."
                  example: csv
                  enum:
                    - csv
                    - xlsx
                    - zip
                options:
                  type: object
                  description: "Type-specific export options. For `chat_messages`: `maxMessages`
                    (required per account, max 10,000,000), `maxChats` (optional
                    per-account chat scrape limit), `skipMassMessages`
                    (optional, bool), `chatIds` (optional array of numeric
                    fan/chat IDs; filters output and can drastically reduce
                    totals). For `media_vault`: `mediaType` (required, one of:
                    `all`, `photo`, `gif`, `video`, `audio`). For `fans`: `type`
                    (required, one of: `all`, `active`, `expired`, `latest`).
                    For `followings`: `type` (required, one of: `all`, `active`,
                    `expired`). For `public_profiles`: `query` (optional,
                    full-text search), `gender` (optional, filter: male, female,
                    trans, couple), `minSubscribePrice` (optional, USD),
                    `maxSubscribePrice` (optional, USD), `location` (optional),
                    `minPostsCount` (optional, minimum posts), `minPhotosCount`
                    (optional, minimum photos), `minVideosCount` (optional,
                    minimum videos), `minSubscribersCount` (optional, minimum
                    subscribers), `maxSubscribersCount` (optional, maximum
                    subscribers), `minJoinDate` (optional, ISO 8601 date),
                    `minLastSeenAt` (optional, ISO 8601 date), `createdAtFrom`
                    (optional, ISO 8601 date, profile added to DB after),
                    `createdAtTo` (optional, ISO 8601 date, profile added to DB
                    before), `instagram` (optional), `twitter` (optional),
                    `tiktok` (optional), `maxResults` (optional, limit
                    results)."
                  example:
                    maxChats: 100
                    maxMessages: 50000
                    skipMassMessages: false
                  properties: {}
                auto_start:
                  type: boolean
                  description: When true, automatically starts the export after creation.
                  example: true
              required:
                - type
                - start_date
                - end_date
                - file_type
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Data Export Status (/api-reference/data-exports/get-data-export-status)

Get the current status and progress of a data export

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/data-exports/{data_export_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/data-exports/{data_export_id}:
    parameters:
      - in: path
        name: data_export_id
        description: The prefixed ID of the data export
        example: data_export_abc123
        required: true
        schema:
          type: string
    get:
      summary: Get Data Export Status
      operationId: getDataExportStatus
      description: Get the current status and progress of a data export
      parameters:
        - in: query
          name: download_url_expires_in
          description: Number of minutes until the download URL expires. Min `1`, max
            `60`, default `5`.
          example: 15
          required: false
          schema:
            type: integer
            description: Number of minutes until the download URL expires. Min `1`, max
              `60`, default `5`.
            example: 15
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: data_export_abc123xyz789
                    type: transactions
                    status: in_progress
                    start_date: 2024-01-01T00:00:00+00:00
                    end_date: 2024-12-31T23:59:59+00:00
                    file_type: csv
                    total_rows: 5000
                    rows_processed: 2500
                    failed_downloads: 0
                    progress_percentage: 50
                    credit_cost: 500
                    export_columns:
                      - transaction_id
                      - type
                      - amount
                      - net_amount
                      - currency
                      - created_at
                    accounts:
                      - id: acct_xyz789abc123
                        display_name: Main Account
                    created_at: 2024-12-02T12:00:00+00:00
                    completed_at: null
                    failed_at: null
                    failed_reason: null
                  _meta:
                    _credits:
                      used: 0
                      balance: 9500
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 60
                      limit_day: null
                      remaining_minute: 56
                      remaining_day: null
                      notice: ""
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: data_export_abc123xyz789
                      type:
                        type: string
                        example: transactions
                      status:
                        type: string
                        example: in_progress
                      start_date:
                        type: string
                        example: 2024-01-01T00:00:00+00:00
                      end_date:
                        type: string
                        example: 2024-12-31T23:59:59+00:00
                      file_type:
                        type: string
                        example: csv
                      total_rows:
                        type: integer
                        example: 5000
                      rows_processed:
                        type: integer
                        example: 2500
                      failed_downloads:
                        type: integer
                        example: 0
                      progress_percentage:
                        type: integer
                        example: 50
                      credit_cost:
                        type: integer
                        example: 500
                      export_columns:
                        type: array
                        example:
                          - transaction_id
                          - type
                          - amount
                          - net_amount
                          - currency
                          - created_at
                        items:
                          type: string
                      accounts:
                        type: array
                        example:
                          - id: acct_xyz789abc123
                            display_name: Main Account
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: acct_xyz789abc123
                            display_name:
                              type: string
                              example: Main Account
                      created_at:
                        type: string
                        example: 2024-12-02T12:00:00+00:00
                      completed_at:
                        type: string
                        example: null
                        nullable: true
                      failed_at:
                        type: string
                        example: null
                        nullable: true
                      failed_reason:
                        type: string
                        example: null
                        nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9500
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 60
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 56
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: ""
      tags:
        - Data Exports
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Data Exports (/api-reference/data-exports/list-data-exports)

Get a paginated list of data exports for the team

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/data-exports
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/data-exports:
    get:
      summary: List Data Exports
      operationId: listDataExports
      description: Get a paginated list of data exports for the team
      parameters:
        - in: query
          name: per_page
          description: Number of results per page. Default `15`, max `100`
          example: 15
          required: false
          schema:
            type: integer
            description: Number of results per page. Default `15`, max `100`
            example: 15
        - in: query
          name: page
          description: Page number for pagination. Default `1`
          example: 1
          required: false
          schema:
            type: integer
            description: Page number for pagination. Default `1`
            example: 1
        - in: query
          name: status
          description: Filter by status
          example: completed
          required: false
          schema:
            type: string
            description: Filter by status
            example: completed
            enum:
              - calculating_credits
              - calculating_credits_failed
              - calculating_credits_completed
              - pending
              - in_progress
              - completed
              - failed
        - in: query
          name: type
          description: Filter by export type
          example: transactions
          required: false
          schema:
            type: string
            description: Filter by export type
            example: transactions
            enum:
              - transactions
              - chat_messages
              - media_vault
              - trial_links
              - tracking_links
              - payouts
              - chargebacks
              - public_profiles
        - in: query
          name: download_url_expires_in
          description: Number of minutes until download URLs expire. Min `1`, max `60`,
            default `5`.
          example: 15
          required: false
          schema:
            type: integer
            description: Number of minutes until download URLs expire. Min `1`, max `60`,
              default `5`.
            example: 15
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    data:
                      - id: data_export_abc123xyz789
                        type: transactions
                        status: completed
                        start_date: 2024-01-01T00:00:00+00:00
                        end_date: 2024-12-31T23:59:59+00:00
                        file_type: csv
                        total_rows: 5000
                        rows_processed: 5000
                        failed_downloads: 0
                        progress_percentage: 100
                        credit_cost: 500
                        export_columns:
                          - transaction_id
                          - type
                          - amount
                          - net_amount
                          - currency
                          - created_at
                        accounts:
                          - id: acct_xyz789abc123
                            display_name: Main Account
                        created_at: 2024-12-01T10:00:00+00:00
                        completed_at: 2024-12-01T10:05:00+00:00
                        failed_at: null
                        failed_reason: null
                        download_url: https://example-bucket.s3.amazonaws.com/data-exports/team-slug/data_export_abc123xyz789.csv?X-Amz-Signature=...
                        download_url_expires_at: 2024-12-02T12:05:00+00:00
                      - id: data_export_def456uvw012
                        type: chat_messages
                        status: in_progress
                        start_date: 2024-06-01T00:00:00+00:00
                        end_date: 2024-12-31T23:59:59+00:00
                        file_type: xlsx
                        total_rows: 15000
                        rows_processed: 7500
                        failed_downloads: 0
                        progress_percentage: 50
                        credit_cost: 1500
                        export_columns:
                          - chat_id
                          - message_id
                          - message_text
                          - fan_username
                          - onlyfans_created_at
                        accounts:
                          - id: acct_xyz789abc123
                            display_name: Main Account
                          - id: acct_mno345pqr678
                            display_name: Secondary Account
                        created_at: 2024-12-02T11:30:00+00:00
                        completed_at: null
                        failed_at: null
                        failed_reason: null
                      - id: data_export_ghi789rst345
                        type: media_vault
                        status: completed
                        start_date: 2024-01-01T00:00:00+00:00
                        end_date: 2024-12-31T23:59:59+00:00
                        file_type: zip
                        total_rows: 79
                        rows_processed: 79
                        failed_downloads: 0
                        progress_percentage: 100
                        credit_cost: 4
                        export_columns: []
                        accounts:
                          - id: acct_xyz789abc123
                            display_name: Main Account
                        created_at: 2024-12-01T09:00:00+00:00
                        completed_at: 2024-12-01T09:08:00+00:00
                        failed_at: null
                        failed_reason: null
                        download_url: https://example-bucket.s3.amazonaws.com/data-exports/team-slug/data_export_ghi789rst345.zip?X-Amz-Signature=...
                        download_url_expires_at: 2024-12-02T12:05:00+00:00
                    meta:
                      current_page: 1
                      last_page: 3
                      per_page: 15
                      total: 42
                  _meta:
                    _credits:
                      used: 0
                      balance: 9500
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 60
                      limit_day: null
                      remaining_minute: 56
                      remaining_day: null
                      notice: ""
                properties:
                  data:
                    type: object
                    properties:
                      data:
                        type: array
                        example:
                          - id: data_export_abc123xyz789
                            type: transactions
                            status: completed
                            start_date: 2024-01-01T00:00:00+00:00
                            end_date: 2024-12-31T23:59:59+00:00
                            file_type: csv
                            total_rows: 5000
                            rows_processed: 5000
                            failed_downloads: 0
                            progress_percentage: 100
                            credit_cost: 500
                            export_columns:
                              - transaction_id
                              - type
                              - amount
                              - net_amount
                              - currency
                              - created_at
                            accounts:
                              - id: acct_xyz789abc123
                                display_name: Main Account
                            created_at: 2024-12-01T10:00:00+00:00
                            completed_at: 2024-12-01T10:05:00+00:00
                            failed_at: null
                            failed_reason: null
                            download_url: https://example-bucket.s3.amazonaws.com/data-exports/team-slug/data_export_abc123xyz789.csv?X-Amz-Signature=...
                            download_url_expires_at: 2024-12-02T12:05:00+00:00
                          - id: data_export_def456uvw012
                            type: chat_messages
                            status: in_progress
                            start_date: 2024-06-01T00:00:00+00:00
                            end_date: 2024-12-31T23:59:59+00:00
                            file_type: xlsx
                            total_rows: 15000
                            rows_processed: 7500
                            failed_downloads: 0
                            progress_percentage: 50
                            credit_cost: 1500
                            export_columns:
                              - chat_id
                              - message_id
                              - message_text
                              - fan_username
                              - onlyfans_created_at
                            accounts:
                              - id: acct_xyz789abc123
                                display_name: Main Account
                              - id: acct_mno345pqr678
                                display_name: Secondary Account
                            created_at: 2024-12-02T11:30:00+00:00
                            completed_at: null
                            failed_at: null
                            failed_reason: null
                          - id: data_export_ghi789rst345
                            type: media_vault
                            status: completed
                            start_date: 2024-01-01T00:00:00+00:00
                            end_date: 2024-12-31T23:59:59+00:00
                            file_type: zip
                            total_rows: 79
                            rows_processed: 79
                            failed_downloads: 0
                            progress_percentage: 100
                            credit_cost: 4
                            export_columns: []
                            accounts:
                              - id: acct_xyz789abc123
                                display_name: Main Account
                            created_at: 2024-12-01T09:00:00+00:00
                            completed_at: 2024-12-01T09:08:00+00:00
                            failed_at: null
                            failed_reason: null
                            download_url: https://example-bucket.s3.amazonaws.com/data-exports/team-slug/data_export_ghi789rst345.zip?X-Amz-Signature=...
                            download_url_expires_at: 2024-12-02T12:05:00+00:00
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: data_export_abc123xyz789
                            type:
                              type: string
                              example: transactions
                            status:
                              type: string
                              example: completed
                            start_date:
                              type: string
                              example: 2024-01-01T00:00:00+00:00
                            end_date:
                              type: string
                              example: 2024-12-31T23:59:59+00:00
                            file_type:
                              type: string
                              example: csv
                            total_rows:
                              type: integer
                              example: 5000
                            rows_processed:
                              type: integer
                              example: 5000
                            failed_downloads:
                              type: integer
                              example: 0
                            progress_percentage:
                              type: integer
                              example: 100
                            credit_cost:
                              type: integer
                              example: 500
                            export_columns:
                              type: array
                              example:
                                - transaction_id
                                - type
                                - amount
                                - net_amount
                                - currency
                                - created_at
                              items:
                                type: string
                            accounts:
                              type: array
                              example:
                                - id: acct_xyz789abc123
                                  display_name: Main Account
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: acct_xyz789abc123
                                  display_name:
                                    type: string
                                    example: Main Account
                            created_at:
                              type: string
                              example: 2024-12-01T10:00:00+00:00
                            completed_at:
                              type: string
                              example: 2024-12-01T10:05:00+00:00
                            failed_at:
                              type: string
                              example: null
                              nullable: true
                            failed_reason:
                              type: string
                              example: null
                              nullable: true
                            download_url:
                              type: string
                              example: https://example-bucket.s3.amazonaws.com/data-exports/team-slug/data_export_abc123xyz789.csv?X-Amz-Signature=...
                            download_url_expires_at:
                              type: string
                              example: 2024-12-02T12:05:00+00:00
                      meta:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          last_page:
                            type: integer
                            example: 3
                          per_page:
                            type: integer
                            example: 15
                          total:
                            type: integer
                            example: 42
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9500
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 60
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 56
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: ""
      tags:
        - Data Exports
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Retry Failed Data Export (/api-reference/data-exports/retry-failed-data-export)

Create a new data export with the same parameters as a failed export and automatically start it.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/data-exports/{data_export_id}/retry
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/data-exports/{data_export_id}/retry:
    parameters:
      - in: path
        name: data_export_id
        description: The prefixed ID of the failed data export
        example: data_export_abc123
        required: true
        schema:
          type: string
    post:
      summary: Retry Failed Data Export
      operationId: retryFailedDataExport
      description: Create a new data export with the same parameters as a failed
        export and automatically start it.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: data_export_new456def
                    original_id: data_export_abc123xyz789
                    type: transactions
                    status: pending
                    message: A new export has been created from the failed export.
                  _meta:
                    _credits:
                      used: 0
                      balance: 9500
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 60
                      limit_day: null
                      remaining_minute: 56
                      remaining_day: null
                      notice: ""
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: data_export_new456def
                      original_id:
                        type: string
                        example: data_export_abc123xyz789
                      type:
                        type: string
                        example: transactions
                      status:
                        type: string
                        example: pending
                      message:
                        type: string
                        example: A new export has been created from the failed export.
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9500
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 60
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 56
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: ""
      tags:
        - Data Exports
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Start Data Export (/api-reference/data-exports/start-data-export)

Start processing a data export that has completed credit calculation. This will begin the actual export process and charge credits.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/data-exports/{data_export_id}/start
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/data-exports/{data_export_id}/start:
    parameters:
      - in: path
        name: data_export_id
        description: The prefixed ID of the data export
        example: data_export_abc123
        required: true
        schema:
          type: string
    post:
      summary: Start Data Export
      operationId: startDataExport
      description: Start processing a data export that has completed credit
        calculation. This will begin the actual export process and charge
        credits.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: data_export_abc123xyz789
                    status: pending
                    message: Data export has been started.
                  _meta:
                    _credits:
                      used: 0
                      balance: 9500
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 60
                      limit_day: null
                      remaining_minute: 56
                      remaining_day: null
                      notice: ""
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: data_export_abc123xyz789
                      status:
                        type: string
                        example: pending
                      message:
                        type: string
                        example: Data export has been started.
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9500
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 60
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 56
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: ""
      tags:
        - Data Exports
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Poll Authentication Status (/api-reference/connect-onlyfans-account/poll-authentication-status)

Poll the status of the authentication process. Eg. if 2FA is required, we will ask you for the code using the `twoFactorPending = true` in the response body. For `mobile_app` auth, the response includes `mobile_auth_session_deeplink` while the session is pending.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/authenticate/{attempt_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/authenticate/{attempt_id}:
    parameters:
      - in: path
        name: attempt_id
        description: The attempt ID of the authentication process
        example: auth_XXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Poll Authentication Status
      operationId: pollAuthenticationStatus
      description: Poll the status of the authentication process. Eg. if 2FA is
        required, we will ask you for the code using the `twoFactorPending =
        true` in the response body. For `mobile_app` auth, the response includes
        `mobile_auth_session_deeplink` while the session is pending.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  account:
                    id: acct_4d3fa20f055b4cbababab0d7e400550d
                    display_name: ipgod@gmail.com
                    onlyfans_data:
                      id: 123456789
                      ip: 127.0.0.1
                      csrf: abcdef123456789
                      name: Demo User
                      view: f
                      about: null
                      email: demo@example.com
                      wsUrl: wss://ws2.onlyfans.com/ws3/00
                      avatar: null
                      header: null
                      isAuth: true
                      ivFlow: default
                      upload:
                        geoUploadArgs:
                          preset: of_beta
                          isDelay: true
                          additional:
                            user: "123456789"
                          needThumbs: true
                          preset_png: of_png
                          protected_preset: of_drm
                      canChat: true
                      hasTags: true
                      website: null
                      advBlock:
                        - subscribe_offers
                      ivStatus: null
                      joinDate: 2022-01-01T00:00:00+00:00
                      lastSeen: 2025-01-01T12:00:00+00:00
                      location: null
                      paidFeed: false
                      username: demouser123
                      wishlist: null
                      hasLabels: false
                      ivCountry: null
                      canAddCard: true
                      canPinPost: true
                      creditsMax: 200
                      creditsMin: 10
                      headerSize: null
                      isVerified: false
                      postsCount: 0
                      audiosCount: 0
                      hasNewHints: true
                      hasScenario: true
                      isPerformer: false
                      mediasCount: 0
                      photosCount: 0
                      videosCount: 0
                      wsAuthToken: dummy.jwt.token
                      avatarThumbs: null
                      canLookStory: true
                      hasNewAlerts: false
                      headerThumbs: null
                      isOtpEnabled: false
                      ivFailReason: Verification failed
                      newTagsCount: 0
                      creditBalance: 0
                      faceIdRegular: []
                      isAgeVerified: true
                      isAllowTweets: false
                      isMakePayment: false
                      needIVApprove: false
                      watermarkText: OnlyFans.com/demouser123
                      canCreateLists: true
                      canPayInternal: true
                      favoritedCount: 0
                      favoritesCount: 0
                      hasPinnedPosts: false
                      isEmailChecked: false
                      isWantComments: true
                      canCommentStory: true
                      countPinnedChat: 0
                      isEmailRequired: false
                      isPaywallPassed: false
                      isRealPerformer: false
                      isVisibleOnline: true
                      showPostsInFeed: true
                      subscribesCount: 0
                      twitterUsername: null
                      canSendChatToAll: false
                      isCreditsEnabled: true
                      pinnedPostsCount: 0
                      subscribersCount: 0
                      chatMessagesCount: 0
                      countPriorityChat: 0
                      hasNotViewedStory: false
                      hasPurchasedPosts: false
                      hasWatermarkPhoto: true
                      hasWatermarkVideo: true
                      isDeleteInitiated: false
                      isReferrerAllowed: false
                      watermarkPosition: bottom_right
                      archivedPostsCount: 0
                      isSpotifyConnected: false
                      isTwitterConnected: false
                      notificationsCount: 0
                      walletFirstRebills: false
                      canConnectOfAccount: false
                      connectedOfAccounts: []
                      hasInternalPayments: false
                      hasNewTicketReplies:
                        open: false
                        closed: false
                        solved: false
                      isRealCardConnected: false
                      maxPinnedPostsCount: 5
                      isWalletAutorecharge: false
                      canReceiveChatMessage: false
                      walletAutorechargeMin: 0
                      ageVerificationSession:
                        url: https://age.yoti.com/age-estimation?sessionId=dummy-session-id&sdkId=dummy-sdk-id
                        status: complete
                        apiFlow: of3
                        expiredAt: 2022-11-15T00:54:42+00:00
                      hasSystemNotifications: false
                      isLegalApprovedAllowed: false
                      isPaymentCardConnected: false
                      ageVerificationRequired: false
                      payoutLegalApproveState: none
                      walletAutorechargeAmount: 0
                      canAlternativeWalletTopUp: false
                      enabledImageEditorForChat: true
                      privateArchivedPostsCount: 0
                      isMarkdownDisabledForAbout: false
                      avatarHeaderConverterUpload: true
                      hasNewChangedPriceSubscriptions: false
                  state: authenticated
                  progress: signed_in
                  lastAttempt:
                    started_at: 2025-03-30T19:40:09.000000Z
                    completed_at: 2025-03-30T19:41:44.000000Z
                    success: true
                    error_message: null
                    error_code: null
                    needs_otp: false
                    otp_phone_ending: null
                properties:
                  account:
                    type: object
                    properties:
                      id:
                        type: string
                        example: acct_4d3fa20f055b4cbababab0d7e400550d
                      display_name:
                        type: string
                        example: ipgod@gmail.com
                      onlyfans_data:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 123456789
                          ip:
                            type: string
                            example: 127.0.0.1
                          csrf:
                            type: string
                            example: abcdef123456789
                          name:
                            type: string
                            example: Demo User
                          view:
                            type: string
                            example: f
                          about:
                            type: string
                            example: null
                            nullable: true
                          email:
                            type: string
                            example: demo@example.com
                          wsUrl:
                            type: string
                            example: wss://ws2.onlyfans.com/ws3/00
                          avatar:
                            type: string
                            example: null
                            nullable: true
                          header:
                            type: string
                            example: null
                            nullable: true
                          isAuth:
                            type: boolean
                            example: true
                          ivFlow:
                            type: string
                            example: default
                          upload:
                            type: object
                            properties:
                              geoUploadArgs:
                                type: object
                                properties:
                                  preset:
                                    type: string
                                    example: of_beta
                                  isDelay:
                                    type: boolean
                                    example: true
                                  additional:
                                    type: object
                                    properties:
                                      user:
                                        type: string
                                        example: "123456789"
                                  needThumbs:
                                    type: boolean
                                    example: true
                                  preset_png:
                                    type: string
                                    example: of_png
                                  protected_preset:
                                    type: string
                                    example: of_drm
                          canChat:
                            type: boolean
                            example: true
                          hasTags:
                            type: boolean
                            example: true
                          website:
                            type: string
                            example: null
                            nullable: true
                          advBlock:
                            type: array
                            example:
                              - subscribe_offers
                            items:
                              type: string
                          ivStatus:
                            type: string
                            example: null
                            nullable: true
                          joinDate:
                            type: string
                            example: 2022-01-01T00:00:00+00:00
                          lastSeen:
                            type: string
                            example: 2025-01-01T12:00:00+00:00
                          location:
                            type: string
                            example: null
                            nullable: true
                          paidFeed:
                            type: boolean
                            example: false
                          username:
                            type: string
                            example: demouser123
                          wishlist:
                            type: string
                            example: null
                            nullable: true
                          hasLabels:
                            type: boolean
                            example: false
                          ivCountry:
                            type: string
                            example: null
                            nullable: true
                          canAddCard:
                            type: boolean
                            example: true
                          canPinPost:
                            type: boolean
                            example: true
                          creditsMax:
                            type: integer
                            example: 200
                          creditsMin:
                            type: integer
                            example: 10
                          headerSize:
                            type: string
                            example: null
                            nullable: true
                          isVerified:
                            type: boolean
                            example: false
                          postsCount:
                            type: integer
                            example: 0
                          audiosCount:
                            type: integer
                            example: 0
                          hasNewHints:
                            type: boolean
                            example: true
                          hasScenario:
                            type: boolean
                            example: true
                          isPerformer:
                            type: boolean
                            example: false
                          mediasCount:
                            type: integer
                            example: 0
                          photosCount:
                            type: integer
                            example: 0
                          videosCount:
                            type: integer
                            example: 0
                          wsAuthToken:
                            type: string
                            example: dummy.jwt.token
                          avatarThumbs:
                            type: string
                            example: null
                            nullable: true
                          canLookStory:
                            type: boolean
                            example: true
                          hasNewAlerts:
                            type: boolean
                            example: false
                          headerThumbs:
                            type: string
                            example: null
                            nullable: true
                          isOtpEnabled:
                            type: boolean
                            example: false
                          ivFailReason:
                            type: string
                            example: Verification failed
                          newTagsCount:
                            type: integer
                            example: 0
                          creditBalance:
                            type: integer
                            example: 0
                          faceIdRegular:
                            type: array
                            example: []
                          isAgeVerified:
                            type: boolean
                            example: true
                          isAllowTweets:
                            type: boolean
                            example: false
                          isMakePayment:
                            type: boolean
                            example: false
                          needIVApprove:
                            type: boolean
                            example: false
                          watermarkText:
                            type: string
                            example: OnlyFans.com/demouser123
                          canCreateLists:
                            type: boolean
                            example: true
                          canPayInternal:
                            type: boolean
                            example: true
                          favoritedCount:
                            type: integer
                            example: 0
                          favoritesCount:
                            type: integer
                            example: 0
                          hasPinnedPosts:
                            type: boolean
                            example: false
                          isEmailChecked:
                            type: boolean
                            example: false
                          isWantComments:
                            type: boolean
                            example: true
                          canCommentStory:
                            type: boolean
                            example: true
                          countPinnedChat:
                            type: integer
                            example: 0
                          isEmailRequired:
                            type: boolean
                            example: false
                          isPaywallPassed:
                            type: boolean
                            example: false
                          isRealPerformer:
                            type: boolean
                            example: false
                          isVisibleOnline:
                            type: boolean
                            example: true
                          showPostsInFeed:
                            type: boolean
                            example: true
                          subscribesCount:
                            type: integer
                            example: 0
                          twitterUsername:
                            type: string
                            example: null
                            nullable: true
                          canSendChatToAll:
                            type: boolean
                            example: false
                          isCreditsEnabled:
                            type: boolean
                            example: true
                          pinnedPostsCount:
                            type: integer
                            example: 0
                          subscribersCount:
                            type: integer
                            example: 0
                          chatMessagesCount:
                            type: integer
                            example: 0
                          countPriorityChat:
                            type: integer
                            example: 0
                          hasNotViewedStory:
                            type: boolean
                            example: false
                          hasPurchasedPosts:
                            type: boolean
                            example: false
                          hasWatermarkPhoto:
                            type: boolean
                            example: true
                          hasWatermarkVideo:
                            type: boolean
                            example: true
                          isDeleteInitiated:
                            type: boolean
                            example: false
                          isReferrerAllowed:
                            type: boolean
                            example: false
                          watermarkPosition:
                            type: string
                            example: bottom_right
                          archivedPostsCount:
                            type: integer
                            example: 0
                          isSpotifyConnected:
                            type: boolean
                            example: false
                          isTwitterConnected:
                            type: boolean
                            example: false
                          notificationsCount:
                            type: integer
                            example: 0
                          walletFirstRebills:
                            type: boolean
                            example: false
                          canConnectOfAccount:
                            type: boolean
                            example: false
                          connectedOfAccounts:
                            type: array
                            example: []
                          hasInternalPayments:
                            type: boolean
                            example: false
                          hasNewTicketReplies:
                            type: object
                            properties:
                              open:
                                type: boolean
                                example: false
                              closed:
                                type: boolean
                                example: false
                              solved:
                                type: boolean
                                example: false
                          isRealCardConnected:
                            type: boolean
                            example: false
                          maxPinnedPostsCount:
                            type: integer
                            example: 5
                          isWalletAutorecharge:
                            type: boolean
                            example: false
                          canReceiveChatMessage:
                            type: boolean
                            example: false
                          walletAutorechargeMin:
                            type: integer
                            example: 0
                          ageVerificationSession:
                            type: object
                            properties:
                              url:
                                type: string
                                example: https://age.yoti.com/age-estimation?sessionId=dummy-session-id&sdkId=dummy-sdk-id
                              status:
                                type: string
                                example: complete
                              apiFlow:
                                type: string
                                example: of3
                              expiredAt:
                                type: string
                                example: 2022-11-15T00:54:42+00:00
                          hasSystemNotifications:
                            type: boolean
                            example: false
                          isLegalApprovedAllowed:
                            type: boolean
                            example: false
                          isPaymentCardConnected:
                            type: boolean
                            example: false
                          ageVerificationRequired:
                            type: boolean
                            example: false
                          payoutLegalApproveState:
                            type: string
                            example: none
                          walletAutorechargeAmount:
                            type: integer
                            example: 0
                          canAlternativeWalletTopUp:
                            type: boolean
                            example: false
                          enabledImageEditorForChat:
                            type: boolean
                            example: true
                          privateArchivedPostsCount:
                            type: integer
                            example: 0
                          isMarkdownDisabledForAbout:
                            type: boolean
                            example: false
                          avatarHeaderConverterUpload:
                            type: boolean
                            example: true
                          hasNewChangedPriceSubscriptions:
                            type: boolean
                            example: false
                  state:
                    type: string
                    example: authenticated
                  progress:
                    type: string
                    example: signed_in
                  lastAttempt:
                    type: object
                    properties:
                      started_at:
                        type: string
                        example: 2025-03-30T19:40:09.000000Z
                      completed_at:
                        type: string
                        example: 2025-03-30T19:41:44.000000Z
                      success:
                        type: boolean
                        example: true
                      error_message:
                        type: string
                        example: null
                        nullable: true
                      error_code:
                        type: string
                        example: null
                        nullable: true
                      needs_otp:
                        type: boolean
                        example: false
                      otp_phone_ending:
                        type: string
                        example: null
                        nullable: true
      tags:
        - Connect OnlyFans Account
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Re-authenticate Account (/api-reference/connect-onlyfans-account/re-authenticate-account)

Trigger account reauthentication without the need to submit email & password again.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/authenticate/{account_id}/reauthenticate
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/authenticate/{account_id}/reauthenticate:
    parameters:
      - in: path
        name: account_id
        description: The Account ID of the authentication process
        example: acct_XXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Re-authenticate Account
      operationId: reAuthenticateAccount
      description: Trigger account reauthentication without the need to submit email &
        password again.
      parameters: []
      responses:
        "200":
          description: Re-authentication started
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  message: Re-authentication started.
                  polling_url: https://app.onlyfansapi.com/api/authenticate/auth_XXXXXXX
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Re-authentication started.
                  polling_url:
                    type: string
                    example: https://app.onlyfansapi.com/api/authenticate/auth_XXXXXXX
        "400":
          description: When re-authentication is not possible
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Can't re-authenticate account at this time.
                  reason: Account is already successfully authenticated
                properties:
                  message:
                    type: string
                    example: Can't re-authenticate account at this time.
                  reason:
                    type: string
                    example: Account is already successfully authenticated
      tags:
        - Connect OnlyFans Account
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Send 2FA E-mail to Creator (/api-reference/connect-onlyfans-account/send2fae-mail-to-creator)

Send 2FA verification e-mail to the creator's email so they can verify login on their device without your input. The e-mail will be sent to the e-mail address used for signing into OnlyFans.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/authenticate/{attempt_id}/send-email-to-creator
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/authenticate/{attempt_id}/send-email-to-creator:
    parameters:
      - in: path
        name: attempt_id
        description: The attempt ID of the authentication process
        example: auth_XXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Send 2FA E-mail to Creator
      operationId: send2FAEMailToCreator
      description: Send 2FA verification e-mail to the creator's email so they can
        verify login on their device without your input. The e-mail will be sent
        to the e-mail address used for signing into OnlyFans.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  message: E-mail sent to creator-123@gmail.com
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: E-mail sent to creator-123@gmail.com
      tags:
        - Connect OnlyFans Account
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Start Authentication (/api-reference/connect-onlyfans-account/start-authentication)

Start the authentication process for a new account. Supports three methods: email/password (default), cookies & headers (raw\_data), or FansAPI Auth+ mobile app (mobile\_app). For email/password, our systems will bypass Captcha and ask you for 2FA if required. For raw\_data, provide session cookies directly for instant authentication. For mobile\_app, the response includes a `mobile_auth_session_deeplink` that the creator opens on their phone (or scans as a QR code) to complete authentication via the FansAPI Auth+ mobile app. All credentials are stored securely and encrypted at rest.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/authenticate
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/authenticate:
    post:
      summary: Start Authentication
      operationId: startAuthentication
      description: "Start the authentication process for a new account. Supports three
        methods: email/password (default), cookies & headers (raw_data), or
        FansAPI Auth+ mobile app (mobile_app). For email/password, our systems
        will bypass Captcha and ask you for 2FA if required. For raw_data,
        provide session cookies directly for instant authentication. For
        mobile_app, the response includes a `mobile_auth_session_deeplink` that
        the creator opens on their phone (or scans as a QR code) to complete
        authentication via the FansAPI Auth+ mobile app. All credentials are
        stored securely and encrypted at rest."
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                oneOf:
                  - description: For email_password or raw_data auth types
                    type: object
                    example:
                      attempt_id: auth_XXXXXXXXXXXXXXXXXXXXX
                      message: Authentication process started. Query the polling_url to check the
                        progress.
                      polling_url: https://app.onlyfansapi.com/api/authenticate/auth_XXXXXXXXXXXXXXXXXXXXX
                    properties:
                      attempt_id:
                        type: string
                        example: auth_XXXXXXXXXXXXXXXXXXXXX
                      message:
                        type: string
                        example: Authentication process started. Query the polling_url to check the
                          progress.
                      polling_url:
                        type: string
                        example: https://app.onlyfansapi.com/api/authenticate/auth_XXXXXXXXXXXXXXXXXXXXX
                  - description: For mobile_app auth type — includes the session code to scan with
                      the FansAPI Auth+ app
                    type: object
                    example:
                      attempt_id: auth_XXXXXXXXXXXXXXXXXXXXX
                      message: Authentication process started. Query the polling_url to check the
                        progress.
                      polling_url: https://app.onlyfansapi.com/api/authenticate/auth_XXXXXXXXXXXXXXXXXXXXX
                      mobile_auth_session_deeplink: fansapiauth://auth/fansapi_auth_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
                    properties:
                      attempt_id:
                        type: string
                        example: auth_XXXXXXXXXXXXXXXXXXXXX
                      message:
                        type: string
                        example: Authentication process started. Query the polling_url to check the
                          progress.
                      polling_url:
                        type: string
                        example: https://app.onlyfansapi.com/api/authenticate/auth_XXXXXXXXXXXXXXXXXXXXX
                      mobile_auth_session_deeplink:
                        type: string
                        example: fansapiauth://auth/fansapi_auth_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
      tags:
        - Connect OnlyFans Account
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                auth_type:
                  type: string
                  description: The authentication method to use. Defaults to `email_password` if
                    omitted. Use `mobile_app` to authenticate via the FansAPI
                    Auth+ mobile app (no credential fields required).
                  example: mobile_app
                  enum:
                    - email_password
                    - raw_data
                    - mobile_app
                name:
                  type: string
                  description: A display name for the account. If omitted, defaults to the email
                    address or auth_id.
                  example: voluptatum
                email:
                  type: string
                  description: The email address of the OnlyFans account. Required when auth_type
                    is `email_password`.
                  example: ken.crona@example.com
                password:
                  type: string
                  description: The password of the OnlyFans account. Required when auth_type is
                    `email_password`.
                  example: UeAoMr
                auth_id:
                  type: string
                  description: The auth_id from OnlyFans session cookies. Required when auth_type
                    is `raw_data`.
                  example: qui
                cookies:
                  type: string
                  description: The full cookie string (semicolon-separated). Required when
                    auth_type is `raw_data`.
                  example: ut
                xbc:
                  type: string
                  description: The X-BC token from request headers. Required when auth_type is
                    `raw_data`.
                  example: explicabo
                user_agent:
                  type: string
                  description: The browser User-Agent string. Required when auth_type is
                    `raw_data`.
                  example: enim
                proxyCountry:
                  type: string
                  description: The country of the managed proxy server you want to use. Eg. "us"
                    for United States. Cannot be used together with customProxy.
                  example: uk
                  enum:
                    - us
                    - uk
                    - gb
                customProxy:
                  type: object
                  description: Custom proxy configuration. Cannot be used together with
                    proxyCountry.
                  example: []
                  properties:
                    host:
                      type: string
                      description: The hostname or IP address of your custom proxy server
                      example: proxy.example.com
                    port:
                      type: integer
                      description: The port number of your custom proxy server (1-65535)
                      example: 8080
                    username:
                      type: string
                      description: The username for proxy authentication (optional)
                      example: sit
                    password:
                      type: string
                      description: The password for proxy authentication (optional)
                      example: +}t]DHZ;N?
                force_connect:
                  type: boolean
                  description: Set to true to connect the account even if it already exists
                  example: false
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Submit 2FA (/api-reference/connect-onlyfans-account/submit2fa)

Submit the 2FA code, or Selfie Verification status, for the authentication process.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml put /api/authenticate/{attempt_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/authenticate/{attempt_id}:
    parameters:
      - in: path
        name: attempt_id
        description: The attempt ID of the authentication process
        example: auth_XXXXXXX
        required: true
        schema:
          type: string
    put:
      summary: Submit 2FA
      operationId: submit2FA
      description: Submit the 2FA code, or Selfie Verification status, for the
        authentication process.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  message: OTP submitted successfully
                properties:
                  message:
                    type: string
                    example: OTP submitted successfully
      tags:
        - Connect OnlyFans Account
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                code:
                  type: string
                  description: The 2FA code you received on your phone. Must be empty if
                    `selfie_verification_completed` is `true`.
                  example: "12345"
                selfie_verification_completed:
                  type: boolean
                  description: This field is required when <code>code</code> is not present.
                  example: "true"
                  enum:
                    - "true"
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Update Authentication Credentials (/api-reference/connect-onlyfans-account/update-authentication-credentials)

Replace the authentication credentials of an existing connected account and trigger a re-authentication. Supports the same three methods as Start Authentication: email/password (default), cookies & headers (raw\_data), or FansAPI Auth+ mobile app (mobile\_app). You can also switch an account from one method to another (e.g. from email\_password to raw\_data). The new credentials are stored securely and encrypted at rest, and re-authentication is started immediately regardless of the account's current session state — running workflows are stopped and API requests return 503 until re-authentication completes. For mobile\_app, the response includes a `mobile_auth_session_deeplink` that the creator opens on their phone to complete authentication.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml put /api/authenticate/{account_id}/credentials
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/authenticate/{account_id}/credentials:
    parameters:
      - in: path
        name: account_id
        description: The Account ID whose credentials should be updated
        example: acct_XXXXXXXXXX
        required: true
        schema:
          type: string
    put:
      summary: Update Authentication Credentials
      operationId: updateAuthenticationCredentials
      description: "Replace the authentication credentials of an existing connected
        account and trigger a re-authentication. Supports the same three methods
        as Start Authentication: email/password (default), cookies & headers
        (raw_data), or FansAPI Auth+ mobile app (mobile_app). You can also
        switch an account from one method to another (e.g. from email_password
        to raw_data). The new credentials are stored securely and encrypted at
        rest, and re-authentication is started immediately regardless of the
        account's current session state — running workflows are stopped and API
        requests return 503 until re-authentication completes. For mobile_app,
        the response includes a `mobile_auth_session_deeplink` that the creator
        opens on their phone to complete authentication."
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                oneOf:
                  - description: For email_password or raw_data auth types
                    type: object
                    example:
                      attempt_id: auth_XXXXXXXXXXXXXXXXXXXXX
                      message: Authentication credentials updated. Re-authentication started. Query
                        the polling_url to check the progress.
                      polling_url: https://app.onlyfansapi.com/api/authenticate/auth_XXXXXXXXXXXXXXXXXXXXX
                    properties:
                      attempt_id:
                        type: string
                        example: auth_XXXXXXXXXXXXXXXXXXXXX
                      message:
                        type: string
                        example: Authentication credentials updated. Re-authentication started. Query
                          the polling_url to check the progress.
                      polling_url:
                        type: string
                        example: https://app.onlyfansapi.com/api/authenticate/auth_XXXXXXXXXXXXXXXXXXXXX
                  - description: For mobile_app auth type — includes the session code to scan with
                      the FansAPI Auth+ app
                    type: object
                    example:
                      attempt_id: auth_XXXXXXXXXXXXXXXXXXXXX
                      message: Authentication credentials updated. Re-authentication started. Query
                        the polling_url to check the progress.
                      polling_url: https://app.onlyfansapi.com/api/authenticate/auth_XXXXXXXXXXXXXXXXXXXXX
                      mobile_auth_session_deeplink: fansapiauth://auth/fansapi_auth_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
                    properties:
                      attempt_id:
                        type: string
                        example: auth_XXXXXXXXXXXXXXXXXXXXX
                      message:
                        type: string
                        example: Authentication credentials updated. Re-authentication started. Query
                          the polling_url to check the progress.
                      polling_url:
                        type: string
                        example: https://app.onlyfansapi.com/api/authenticate/auth_XXXXXXXXXXXXXXXXXXXXX
                      mobile_auth_session_deeplink:
                        type: string
                        example: fansapiauth://auth/fansapi_auth_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
      tags:
        - Connect OnlyFans Account
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                auth_type:
                  type: string
                  description: The authentication method to use. Defaults to `email_password` if
                    omitted.
                  example: email_password
                  enum:
                    - email_password
                    - raw_data
                    - mobile_app
                email:
                  type: string
                  description: The email address of the OnlyFans account. Required when auth_type
                    is `email_password`.
                  example: watsica.annamae@example.net
                password:
                  type: string
                  description: The password of the OnlyFans account. Required when auth_type is
                    `email_password`.
                  example: "@g-9V#74X;U6b4ph8!o"
                auth_id:
                  type: string
                  description: The auth_id from OnlyFans session cookies. Required when auth_type
                    is `raw_data`.
                  example: in
                cookies:
                  type: string
                  description: The full cookie string (semicolon-separated). Required when
                    auth_type is `raw_data`.
                  example: eum
                xbc:
                  type: string
                  description: The X-BC token from request headers. Required when auth_type is
                    `raw_data`.
                  example: atque
                user_agent:
                  type: string
                  description: The browser User-Agent string. Required when auth_type is
                    `raw_data`.
                  example: quae
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Direct Messages Chart (/api-reference/engagement-messages/direct-messages-chart)

Get engagement chart metrics for direct messages: sent count and purchase amount over time.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/engagement/messages/direct-messages/chart
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/engagement/messages/direct-messages/chart:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Direct Messages Chart
      operationId: directMessagesChart
      description: "Get engagement chart metrics for direct messages: sent count and
        purchase amount over time."
      parameters:
        - in: query
          name: startDate
          description: Start of the chart window in `Y-m-d H:i:s` format.
          example: 2026-01-07 00:00:00
          required: false
          schema:
            type: string
            description: Start of the chart window in `Y-m-d H:i:s` format.
            example: 2026-01-07 00:00:00
        - in: query
          name: endDate
          description: End of the chart window in `Y-m-d H:i:s` format. It must be after
            `startDate`.
          example: 2026-02-06 22:19:59
          required: false
          schema:
            type: string
            description: End of the chart window in `Y-m-d H:i:s` format. It must be after
              `startDate`.
            example: 2026-02-06 22:19:59
        - in: query
          name: withTotal
          description: Include `total` and `delta` aggregates in the response. Defaults to
            `true`.
          example: true
          required: false
          schema:
            type: boolean
            description: Include `total` and `delta` aggregates in the response. Defaults to
              `true`.
            example: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    direct_messages:
                      chart:
                        - date: 2026-01-07T00:00:00+00:00
                          count: 436
                        - date: 2026-01-08T00:00:00+00:00
                          count: 403
                        - date: 2026-01-09T00:00:00+00:00
                          count: 587
                        - date: 2026-01-10T00:00:00+00:00
                          count: 543
                        - date: 2026-01-11T00:00:00+00:00
                          count: 622
                        - date: 2026-01-12T00:00:00+00:00
                          count: 538
                        - date: 2026-01-13T00:00:00+00:00
                          count: 326
                        - date: 2026-01-14T00:00:00+00:00
                          count: 569
                        - date: 2026-01-15T00:00:00+00:00
                          count: 478
                        - date: 2026-01-16T00:00:00+00:00
                          count: 506
                        - date: 2026-01-17T00:00:00+00:00
                          count: 611
                        - date: 2026-01-18T00:00:00+00:00
                          count: 593
                        - date: 2026-01-19T00:00:00+00:00
                          count: 875
                        - date: 2026-01-20T00:00:00+00:00
                          count: 1178
                        - date: 2026-01-21T00:00:00+00:00
                          count: 1331
                        - date: 2026-01-22T00:00:00+00:00
                          count: 1277
                        - date: 2026-01-23T00:00:00+00:00
                          count: 1153
                        - date: 2026-01-24T00:00:00+00:00
                          count: 1255
                        - date: 2026-01-25T00:00:00+00:00
                          count: 1179
                        - date: 2026-01-26T00:00:00+00:00
                          count: 1147
                        - date: 2026-01-27T00:00:00+00:00
                          count: 905
                        - date: 2026-01-28T00:00:00+00:00
                          count: 1467
                        - date: 2026-01-29T00:00:00+00:00
                          count: 1681
                        - date: 2026-01-30T00:00:00+00:00
                          count: 1827
                        - date: 2026-01-31T00:00:00+00:00
                          count: 1501
                        - date: 2026-02-01T00:00:00+00:00
                          count: 935
                        - date: 2026-02-02T00:00:00+00:00
                          count: 922
                        - date: 2026-02-03T00:00:00+00:00
                          count: 1059
                        - date: 2026-02-04T00:00:00+00:00
                          count: 1124
                        - date: 2026-02-05T00:00:00+00:00
                          count: 1111
                        - date: 2026-02-06T00:00:00+00:00
                          count: 1155
                      total: 29294
                      delta: 71
                    direct_messages_purchases:
                      chart:
                        - date: 2026-01-07T00:00:00+00:00
                          count: 4229.47
                        - date: 2026-01-08T00:00:00+00:00
                          count: 3501.2
                        - date: 2026-01-09T00:00:00+00:00
                          count: 7119.34
                        - date: 2026-01-10T00:00:00+00:00
                          count: 5141.29
                        - date: 2026-01-11T00:00:00+00:00
                          count: 8131.15
                        - date: 2026-01-12T00:00:00+00:00
                          count: 5387.46
                        - date: 2026-01-13T00:00:00+00:00
                          count: 2680.16
                        - date: 2026-01-14T00:00:00+00:00
                          count: 3728.25
                        - date: 2026-01-15T00:00:00+00:00
                          count: 4577.14
                        - date: 2026-01-16T00:00:00+00:00
                          count: 4369.77
                        - date: 2026-01-17T00:00:00+00:00
                          count: 7509.09
                        - date: 2026-01-18T00:00:00+00:00
                          count: 3741.5
                        - date: 2026-01-19T00:00:00+00:00
                          count: 3089.89
                        - date: 2026-01-20T00:00:00+00:00
                          count: 5318.68
                        - date: 2026-01-21T00:00:00+00:00
                          count: 6722.56
                        - date: 2026-01-22T00:00:00+00:00
                          count: 4585.53
                        - date: 2026-01-23T00:00:00+00:00
                          count: 8163.06
                        - date: 2026-01-24T00:00:00+00:00
                          count: 4872.21
                        - date: 2026-01-25T00:00:00+00:00
                          count: 5804.55
                        - date: 2026-01-26T00:00:00+00:00
                          count: 5393.57
                        - date: 2026-01-27T00:00:00+00:00
                          count: 3874.12
                        - date: 2026-01-28T00:00:00+00:00
                          count: 6735.14
                        - date: 2026-01-29T00:00:00+00:00
                          count: 7908.03
                        - date: 2026-01-30T00:00:00+00:00
                          count: 11120.55
                        - date: 2026-01-31T00:00:00+00:00
                          count: 12434.52
                        - date: 2026-02-01T00:00:00+00:00
                          count: 6016.15
                        - date: 2026-02-02T00:00:00+00:00
                          count: 3772.66
                        - date: 2026-02-03T00:00:00+00:00
                          count: 5710.38
                        - date: 2026-02-04T00:00:00+00:00
                          count: 5652.75
                        - date: 2026-02-05T00:00:00+00:00
                          count: 6934.73
                        - date: 2026-02-06T00:00:00+00:00
                          count: 5046.19
                      total: 179903.2
                      delta: 26.6
                  _meta:
                    _credits:
                      used: 1
                      balance: 11270560
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4998
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      direct_messages:
                        type: object
                        properties:
                          chart:
                            type: array
                            example:
                              - date: 2026-01-07T00:00:00+00:00
                                count: 436
                              - date: 2026-01-08T00:00:00+00:00
                                count: 403
                              - date: 2026-01-09T00:00:00+00:00
                                count: 587
                              - date: 2026-01-10T00:00:00+00:00
                                count: 543
                              - date: 2026-01-11T00:00:00+00:00
                                count: 622
                              - date: 2026-01-12T00:00:00+00:00
                                count: 538
                              - date: 2026-01-13T00:00:00+00:00
                                count: 326
                              - date: 2026-01-14T00:00:00+00:00
                                count: 569
                              - date: 2026-01-15T00:00:00+00:00
                                count: 478
                              - date: 2026-01-16T00:00:00+00:00
                                count: 506
                              - date: 2026-01-17T00:00:00+00:00
                                count: 611
                              - date: 2026-01-18T00:00:00+00:00
                                count: 593
                              - date: 2026-01-19T00:00:00+00:00
                                count: 875
                              - date: 2026-01-20T00:00:00+00:00
                                count: 1178
                              - date: 2026-01-21T00:00:00+00:00
                                count: 1331
                              - date: 2026-01-22T00:00:00+00:00
                                count: 1277
                              - date: 2026-01-23T00:00:00+00:00
                                count: 1153
                              - date: 2026-01-24T00:00:00+00:00
                                count: 1255
                              - date: 2026-01-25T00:00:00+00:00
                                count: 1179
                              - date: 2026-01-26T00:00:00+00:00
                                count: 1147
                              - date: 2026-01-27T00:00:00+00:00
                                count: 905
                              - date: 2026-01-28T00:00:00+00:00
                                count: 1467
                              - date: 2026-01-29T00:00:00+00:00
                                count: 1681
                              - date: 2026-01-30T00:00:00+00:00
                                count: 1827
                              - date: 2026-01-31T00:00:00+00:00
                                count: 1501
                              - date: 2026-02-01T00:00:00+00:00
                                count: 935
                              - date: 2026-02-02T00:00:00+00:00
                                count: 922
                              - date: 2026-02-03T00:00:00+00:00
                                count: 1059
                              - date: 2026-02-04T00:00:00+00:00
                                count: 1124
                              - date: 2026-02-05T00:00:00+00:00
                                count: 1111
                              - date: 2026-02-06T00:00:00+00:00
                                count: 1155
                            items:
                              type: object
                              properties:
                                date:
                                  type: string
                                  example: 2026-01-07T00:00:00+00:00
                                count:
                                  type: integer
                                  example: 436
                          total:
                            type: integer
                            example: 29294
                          delta:
                            type: integer
                            example: 71
                      direct_messages_purchases:
                        type: object
                        properties:
                          chart:
                            type: array
                            example:
                              - date: 2026-01-07T00:00:00+00:00
                                count: 4229.47
                              - date: 2026-01-08T00:00:00+00:00
                                count: 3501.2
                              - date: 2026-01-09T00:00:00+00:00
                                count: 7119.34
                              - date: 2026-01-10T00:00:00+00:00
                                count: 5141.29
                              - date: 2026-01-11T00:00:00+00:00
                                count: 8131.15
                              - date: 2026-01-12T00:00:00+00:00
                                count: 5387.46
                              - date: 2026-01-13T00:00:00+00:00
                                count: 2680.16
                              - date: 2026-01-14T00:00:00+00:00
                                count: 3728.25
                              - date: 2026-01-15T00:00:00+00:00
                                count: 4577.14
                              - date: 2026-01-16T00:00:00+00:00
                                count: 4369.77
                              - date: 2026-01-17T00:00:00+00:00
                                count: 7509.09
                              - date: 2026-01-18T00:00:00+00:00
                                count: 3741.5
                              - date: 2026-01-19T00:00:00+00:00
                                count: 3089.89
                              - date: 2026-01-20T00:00:00+00:00
                                count: 5318.68
                              - date: 2026-01-21T00:00:00+00:00
                                count: 6722.56
                              - date: 2026-01-22T00:00:00+00:00
                                count: 4585.53
                              - date: 2026-01-23T00:00:00+00:00
                                count: 8163.06
                              - date: 2026-01-24T00:00:00+00:00
                                count: 4872.21
                              - date: 2026-01-25T00:00:00+00:00
                                count: 5804.55
                              - date: 2026-01-26T00:00:00+00:00
                                count: 5393.57
                              - date: 2026-01-27T00:00:00+00:00
                                count: 3874.12
                              - date: 2026-01-28T00:00:00+00:00
                                count: 6735.14
                              - date: 2026-01-29T00:00:00+00:00
                                count: 7908.03
                              - date: 2026-01-30T00:00:00+00:00
                                count: 11120.55
                              - date: 2026-01-31T00:00:00+00:00
                                count: 12434.52
                              - date: 2026-02-01T00:00:00+00:00
                                count: 6016.15
                              - date: 2026-02-02T00:00:00+00:00
                                count: 3772.66
                              - date: 2026-02-03T00:00:00+00:00
                                count: 5710.38
                              - date: 2026-02-04T00:00:00+00:00
                                count: 5652.75
                              - date: 2026-02-05T00:00:00+00:00
                                count: 6934.73
                              - date: 2026-02-06T00:00:00+00:00
                                count: 5046.19
                            items:
                              type: object
                              properties:
                                date:
                                  type: string
                                  example: 2026-01-07T00:00:00+00:00
                                count:
                                  type: number
                                  example: 4229.47
                          total:
                            type: number
                            example: 179903.2
                          delta:
                            type: number
                            example: 26.6
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 11270560
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4998
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Engagement / Messages
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Direct Messages (/api-reference/engagement-messages/direct-messages)

List sent direct messages with engagement stats (sent, viewed, purchased, etc.).

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/engagement/messages/direct-messages
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/engagement/messages/direct-messages:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Direct Messages
      operationId: directMessages
      description: List sent direct messages with engagement stats (sent, viewed,
        purchased, etc.).
      parameters:
        - in: query
          name: startDate
          description: The earliest message to retrieve. Keep empty to get all.
          example: 2026-01-07 00:00:00
          required: false
          schema:
            type: string
            description: The earliest message to retrieve. Keep empty to get all.
            example: 2026-01-07 00:00:00
        - in: query
          name: endDate
          description: The latest message to retrieve. Keep empty to get all. It must be
            after `startDate` and is also used for pagination.
          example: 2026-02-06 01:26:15
          required: false
          schema:
            type: string
            description: The latest message to retrieve. Keep empty to get all. It must be
              after `startDate` and is also used for pagination.
            example: 2026-02-06 01:26:15
        - in: query
          name: limit
          description: Number of messages to return (default = 10)
          example: 10
          required: false
          schema:
            type: integer
            description: Number of messages to return (default = 10)
            example: 10
        - in: query
          name: query
          description: Optionally, filter by message text.
          example: sciss
          required: false
          schema:
            type: string
            description: Optionally, filter by message text.
            example: sciss
        - in: query
          name: offset
          description: Optional offset for manual pagination.
          example: 0
          required: false
          schema:
            type: integer
            description: Optional offset for manual pagination.
            example: 0
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    hasMore: true
                    items:
                      - id: 2233445566
                        date: 2026-02-06T01:20:15+00:00
                        responseType: message
                        text: <p>SCISSORS</p>
                        rawText: SCISSORS
                        giphyId: null
                        isFree: false
                        isMediaReady: true
                        mediaCount: 1
                        media:
                          - id: 3344556677
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: 2025-03-30T23:06:00+00:00
                            isReady: true
                            files:
                              full:
                                url: https://cdn.example.com/files/placeholder/image.jpg
                                width: 2801
                                height: 3735
                                size: 0
                                sources: []
                              thumb:
                                url: https://cdn.example.com/files/placeholder/thumb.jpg
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: https://cdn.example.com/files/placeholder/preview.jpg
                                width: 960
                                height: 1281
                                size: 0
                              squarePreview:
                                url: https://cdn.example.com/files/placeholder/square.jpg
                                width: 960
                                height: 960
                                size: 0
                            duration: 0
                            hasCustomPreview: false
                            videoSources:
                              "240": null
                              "720": null
                        previews: []
                        isTip: false
                        isReportedByMe: false
                        viewedCount: 0
                        sentCount: 1
                        isCanceled: false
                        template: direct
                        messageId: 4455667788990
                        toUserId: 55667788
                        canUnsend: true
                        unsendSeconds: 1000000
                        price: "29.99"
                        purchasedCount: 0
                        canSendMessageToBuyers: false
                  _pagination:
                    next_page: https://app.onlyfansapi.com/api/acct_XXXXXXXXXX/engagement/messages/direct-messages?endDate=2026-02-06%2002%3A53%3A05&limit=10
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999959
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49988
                properties:
                  data:
                    type: object
                    properties:
                      hasMore:
                        type: boolean
                        example: true
                      items:
                        type: array
                        example:
                          - id: 2233445566
                            date: 2026-02-06T01:20:15+00:00
                            responseType: message
                            text: <p>SCISSORS</p>
                            rawText: SCISSORS
                            giphyId: null
                            isFree: false
                            isMediaReady: true
                            mediaCount: 1
                            media:
                              - id: 3344556677
                                type: photo
                                convertedToVideo: false
                                canView: true
                                hasError: false
                                createdAt: 2025-03-30T23:06:00+00:00
                                isReady: true
                                files:
                                  full:
                                    url: https://cdn.example.com/files/placeholder/image.jpg
                                    width: 2801
                                    height: 3735
                                    size: 0
                                    sources: []
                                  thumb:
                                    url: https://cdn.example.com/files/placeholder/thumb.jpg
                                    width: 300
                                    height: 300
                                    size: 0
                                  preview:
                                    url: https://cdn.example.com/files/placeholder/preview.jpg
                                    width: 960
                                    height: 1281
                                    size: 0
                                  squarePreview:
                                    url: https://cdn.example.com/files/placeholder/square.jpg
                                    width: 960
                                    height: 960
                                    size: 0
                                duration: 0
                                hasCustomPreview: false
                                videoSources:
                                  "240": null
                                  "720": null
                            previews: []
                            isTip: false
                            isReportedByMe: false
                            viewedCount: 0
                            sentCount: 1
                            isCanceled: false
                            template: direct
                            messageId: 4455667788990
                            toUserId: 55667788
                            canUnsend: true
                            unsendSeconds: 1000000
                            price: "29.99"
                            purchasedCount: 0
                            canSendMessageToBuyers: false
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 2233445566
                            date:
                              type: string
                              example: 2026-02-06T01:20:15+00:00
                            responseType:
                              type: string
                              example: message
                            text:
                              type: string
                              example: <p>SCISSORS</p>
                            rawText:
                              type: string
                              example: SCISSORS
                            giphyId:
                              type: string
                              example: null
                              nullable: true
                            isFree:
                              type: boolean
                              example: false
                            isMediaReady:
                              type: boolean
                              example: true
                            mediaCount:
                              type: integer
                              example: 1
                            media:
                              type: array
                              example:
                                - id: 3344556677
                                  type: photo
                                  convertedToVideo: false
                                  canView: true
                                  hasError: false
                                  createdAt: 2025-03-30T23:06:00+00:00
                                  isReady: true
                                  files:
                                    full:
                                      url: https://cdn.example.com/files/placeholder/image.jpg
                                      width: 2801
                                      height: 3735
                                      size: 0
                                      sources: []
                                    thumb:
                                      url: https://cdn.example.com/files/placeholder/thumb.jpg
                                      width: 300
                                      height: 300
                                      size: 0
                                    preview:
                                      url: https://cdn.example.com/files/placeholder/preview.jpg
                                      width: 960
                                      height: 1281
                                      size: 0
                                    squarePreview:
                                      url: https://cdn.example.com/files/placeholder/square.jpg
                                      width: 960
                                      height: 960
                                      size: 0
                                  duration: 0
                                  hasCustomPreview: false
                                  videoSources:
                                    "240": null
                                    "720": null
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 3344556677
                                  type:
                                    type: string
                                    example: photo
                                  convertedToVideo:
                                    type: boolean
                                    example: false
                                  canView:
                                    type: boolean
                                    example: true
                                  hasError:
                                    type: boolean
                                    example: false
                                  createdAt:
                                    type: string
                                    example: 2025-03-30T23:06:00+00:00
                                  isReady:
                                    type: boolean
                                    example: true
                                  files:
                                    type: object
                                    properties:
                                      full:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                            example: https://cdn.example.com/files/placeholder/image.jpg
                                          width:
                                            type: integer
                                            example: 2801
                                          height:
                                            type: integer
                                            example: 3735
                                          size:
                                            type: integer
                                            example: 0
                                          sources:
                                            type: array
                                            example: []
                                      thumb:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                            example: https://cdn.example.com/files/placeholder/thumb.jpg
                                          width:
                                            type: integer
                                            example: 300
                                          height:
                                            type: integer
                                            example: 300
                                          size:
                                            type: integer
                                            example: 0
                                      preview:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                            example: https://cdn.example.com/files/placeholder/preview.jpg
                                          width:
                                            type: integer
                                            example: 960
                                          height:
                                            type: integer
                                            example: 1281
                                          size:
                                            type: integer
                                            example: 0
                                      squarePreview:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                            example: https://cdn.example.com/files/placeholder/square.jpg
                                          width:
                                            type: integer
                                            example: 960
                                          height:
                                            type: integer
                                            example: 960
                                          size:
                                            type: integer
                                            example: 0
                                  duration:
                                    type: integer
                                    example: 0
                                  hasCustomPreview:
                                    type: boolean
                                    example: false
                                  videoSources:
                                    type: object
                                    properties:
                                      "240":
                                        type: string
                                        example: null
                                        nullable: true
                                      "720":
                                        type: string
                                        example: null
                                        nullable: true
                            previews:
                              type: array
                              example: []
                            isTip:
                              type: boolean
                              example: false
                            isReportedByMe:
                              type: boolean
                              example: false
                            viewedCount:
                              type: integer
                              example: 0
                            sentCount:
                              type: integer
                              example: 1
                            isCanceled:
                              type: boolean
                              example: false
                            template:
                              type: string
                              example: direct
                            messageId:
                              type: integer
                              example: 4455667788990
                            toUserId:
                              type: integer
                              example: 55667788
                            canUnsend:
                              type: boolean
                              example: true
                            unsendSeconds:
                              type: integer
                              example: 1000000
                            price:
                              type: string
                              example: "29.99"
                            purchasedCount:
                              type: integer
                              example: 0
                            canSendMessageToBuyers:
                              type: boolean
                              example: false
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: https://app.onlyfansapi.com/api/acct_XXXXXXXXXX/engagement/messages/direct-messages?endDate=2026-02-06%2002%3A53%3A05&limit=10
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999959
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49988
      tags:
        - Engagement / Messages
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Mass Messages Chart (/api-reference/engagement-messages/mass-messages-chart)

Get engagement chart metrics for mass messages: sent count and purchase amount over time.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/engagement/messages/mass-messages/chart
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/engagement/messages/mass-messages/chart:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Mass Messages Chart
      operationId: massMessagesChart
      description: "Get engagement chart metrics for mass messages: sent count and
        purchase amount over time."
      parameters:
        - in: query
          name: startDate
          description: Start of the chart window in `Y-m-d H:i:s` format.
          example: 2026-01-07 00:00:00
          required: false
          schema:
            type: string
            description: Start of the chart window in `Y-m-d H:i:s` format.
            example: 2026-01-07 00:00:00
        - in: query
          name: endDate
          description: End of the chart window in `Y-m-d H:i:s` format. It must be after
            `startDate`.
          example: 2026-02-06 22:19:59
          required: false
          schema:
            type: string
            description: End of the chart window in `Y-m-d H:i:s` format. It must be after
              `startDate`.
            example: 2026-02-06 22:19:59
        - in: query
          name: withTotal
          description: Include `total` and `delta` aggregates in the response. Defaults to
            `true`.
          example: true
          required: false
          schema:
            type: boolean
            description: Include `total` and `delta` aggregates in the response. Defaults to
              `true`.
            example: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    group_messages:
                      chart:
                        - date: 2026-01-07T00:00:00+00:00
                          count: 8
                        - date: 2026-01-08T00:00:00+00:00
                          count: 5
                        - date: 2026-01-09T00:00:00+00:00
                          count: 10
                        - date: 2026-01-10T00:00:00+00:00
                          count: 7
                        - date: 2026-01-11T00:00:00+00:00
                          count: 9
                        - date: 2026-01-12T00:00:00+00:00
                          count: 11
                        - date: 2026-01-13T00:00:00+00:00
                          count: 6
                        - date: 2026-01-14T00:00:00+00:00
                          count: 9
                        - date: 2026-01-15T00:00:00+00:00
                          count: 9
                        - date: 2026-01-16T00:00:00+00:00
                          count: 12
                        - date: 2026-01-17T00:00:00+00:00
                          count: 8
                        - date: 2026-01-18T00:00:00+00:00
                          count: 9
                        - date: 2026-01-19T00:00:00+00:00
                          count: 8
                        - date: 2026-01-20T00:00:00+00:00
                          count: 5
                        - date: 2026-01-21T00:00:00+00:00
                          count: 8
                        - date: 2026-01-22T00:00:00+00:00
                          count: 11
                        - date: 2026-01-23T00:00:00+00:00
                          count: 9
                        - date: 2026-01-24T00:00:00+00:00
                          count: 8
                        - date: 2026-01-25T00:00:00+00:00
                          count: 8
                        - date: 2026-01-26T00:00:00+00:00
                          count: 10
                        - date: 2026-01-27T00:00:00+00:00
                          count: 5
                        - date: 2026-01-28T00:00:00+00:00
                          count: 7
                        - date: 2026-01-29T00:00:00+00:00
                          count: 6
                        - date: 2026-01-30T00:00:00+00:00
                          count: 9
                        - date: 2026-01-31T00:00:00+00:00
                          count: 4
                        - date: 2026-02-01T00:00:00+00:00
                          count: 6
                        - date: 2026-02-02T00:00:00+00:00
                          count: 12
                        - date: 2026-02-03T00:00:00+00:00
                          count: 6
                        - date: 2026-02-04T00:00:00+00:00
                          count: 10
                        - date: 2026-02-05T00:00:00+00:00
                          count: 13
                        - date: 2026-02-06T00:00:00+00:00
                          count: 8
                      total: 256
                      delta: 32.6
                    group_messages_purchases:
                      chart:
                        - date: 2026-01-07T00:00:00+00:00
                          count: 846.54
                        - date: 2026-01-08T00:00:00+00:00
                          count: 549.11
                        - date: 2026-01-09T00:00:00+00:00
                          count: 1665.94
                        - date: 2026-01-10T00:00:00+00:00
                          count: 1063.36
                        - date: 2026-01-11T00:00:00+00:00
                          count: 1368.39
                        - date: 2026-01-12T00:00:00+00:00
                          count: 1207.98
                        - date: 2026-01-13T00:00:00+00:00
                          count: 1067.6
                        - date: 2026-01-14T00:00:00+00:00
                          count: 1009.73
                        - date: 2026-01-15T00:00:00+00:00
                          count: 548.28
                        - date: 2026-01-16T00:00:00+00:00
                          count: 1225.95
                        - date: 2026-01-17T00:00:00+00:00
                          count: 729.63
                        - date: 2026-01-18T00:00:00+00:00
                          count: 1031.37
                        - date: 2026-01-19T00:00:00+00:00
                          count: 1030.77
                        - date: 2026-01-20T00:00:00+00:00
                          count: 664.54
                        - date: 2026-01-21T00:00:00+00:00
                          count: 989.29
                        - date: 2026-01-22T00:00:00+00:00
                          count: 1208.15
                        - date: 2026-01-23T00:00:00+00:00
                          count: 981.15
                        - date: 2026-01-24T00:00:00+00:00
                          count: 807.61
                        - date: 2026-01-25T00:00:00+00:00
                          count: 1343.55
                        - date: 2026-01-26T00:00:00+00:00
                          count: 1040.85
                        - date: 2026-01-27T00:00:00+00:00
                          count: 468.98
                        - date: 2026-01-28T00:00:00+00:00
                          count: 1515.54
                        - date: 2026-01-29T00:00:00+00:00
                          count: 1497.24
                        - date: 2026-01-30T00:00:00+00:00
                          count: 1331.33
                        - date: 2026-01-31T00:00:00+00:00
                          count: 938.93
                        - date: 2026-02-01T00:00:00+00:00
                          count: 372.78
                        - date: 2026-02-02T00:00:00+00:00
                          count: 780.88
                        - date: 2026-02-03T00:00:00+00:00
                          count: 521.2
                        - date: 2026-02-04T00:00:00+00:00
                          count: 1409.73
                        - date: 2026-02-05T00:00:00+00:00
                          count: 1330.83
                        - date: 2026-02-06T00:00:00+00:00
                          count: 1504.63
                      total: 32131
                      delta: -1.7
                  _meta:
                    _credits:
                      used: 1
                      balance: 11270561
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      group_messages:
                        type: object
                        properties:
                          chart:
                            type: array
                            example:
                              - date: 2026-01-07T00:00:00+00:00
                                count: 8
                              - date: 2026-01-08T00:00:00+00:00
                                count: 5
                              - date: 2026-01-09T00:00:00+00:00
                                count: 10
                              - date: 2026-01-10T00:00:00+00:00
                                count: 7
                              - date: 2026-01-11T00:00:00+00:00
                                count: 9
                              - date: 2026-01-12T00:00:00+00:00
                                count: 11
                              - date: 2026-01-13T00:00:00+00:00
                                count: 6
                              - date: 2026-01-14T00:00:00+00:00
                                count: 9
                              - date: 2026-01-15T00:00:00+00:00
                                count: 9
                              - date: 2026-01-16T00:00:00+00:00
                                count: 12
                              - date: 2026-01-17T00:00:00+00:00
                                count: 8
                              - date: 2026-01-18T00:00:00+00:00
                                count: 9
                              - date: 2026-01-19T00:00:00+00:00
                                count: 8
                              - date: 2026-01-20T00:00:00+00:00
                                count: 5
                              - date: 2026-01-21T00:00:00+00:00
                                count: 8
                              - date: 2026-01-22T00:00:00+00:00
                                count: 11
                              - date: 2026-01-23T00:00:00+00:00
                                count: 9
                              - date: 2026-01-24T00:00:00+00:00
                                count: 8
                              - date: 2026-01-25T00:00:00+00:00
                                count: 8
                              - date: 2026-01-26T00:00:00+00:00
                                count: 10
                              - date: 2026-01-27T00:00:00+00:00
                                count: 5
                              - date: 2026-01-28T00:00:00+00:00
                                count: 7
                              - date: 2026-01-29T00:00:00+00:00
                                count: 6
                              - date: 2026-01-30T00:00:00+00:00
                                count: 9
                              - date: 2026-01-31T00:00:00+00:00
                                count: 4
                              - date: 2026-02-01T00:00:00+00:00
                                count: 6
                              - date: 2026-02-02T00:00:00+00:00
                                count: 12
                              - date: 2026-02-03T00:00:00+00:00
                                count: 6
                              - date: 2026-02-04T00:00:00+00:00
                                count: 10
                              - date: 2026-02-05T00:00:00+00:00
                                count: 13
                              - date: 2026-02-06T00:00:00+00:00
                                count: 8
                            items:
                              type: object
                              properties:
                                date:
                                  type: string
                                  example: 2026-01-07T00:00:00+00:00
                                count:
                                  type: integer
                                  example: 8
                          total:
                            type: integer
                            example: 256
                          delta:
                            type: number
                            example: 32.6
                      group_messages_purchases:
                        type: object
                        properties:
                          chart:
                            type: array
                            example:
                              - date: 2026-01-07T00:00:00+00:00
                                count: 846.54
                              - date: 2026-01-08T00:00:00+00:00
                                count: 549.11
                              - date: 2026-01-09T00:00:00+00:00
                                count: 1665.94
                              - date: 2026-01-10T00:00:00+00:00
                                count: 1063.36
                              - date: 2026-01-11T00:00:00+00:00
                                count: 1368.39
                              - date: 2026-01-12T00:00:00+00:00
                                count: 1207.98
                              - date: 2026-01-13T00:00:00+00:00
                                count: 1067.6
                              - date: 2026-01-14T00:00:00+00:00
                                count: 1009.73
                              - date: 2026-01-15T00:00:00+00:00
                                count: 548.28
                              - date: 2026-01-16T00:00:00+00:00
                                count: 1225.95
                              - date: 2026-01-17T00:00:00+00:00
                                count: 729.63
                              - date: 2026-01-18T00:00:00+00:00
                                count: 1031.37
                              - date: 2026-01-19T00:00:00+00:00
                                count: 1030.77
                              - date: 2026-01-20T00:00:00+00:00
                                count: 664.54
                              - date: 2026-01-21T00:00:00+00:00
                                count: 989.29
                              - date: 2026-01-22T00:00:00+00:00
                                count: 1208.15
                              - date: 2026-01-23T00:00:00+00:00
                                count: 981.15
                              - date: 2026-01-24T00:00:00+00:00
                                count: 807.61
                              - date: 2026-01-25T00:00:00+00:00
                                count: 1343.55
                              - date: 2026-01-26T00:00:00+00:00
                                count: 1040.85
                              - date: 2026-01-27T00:00:00+00:00
                                count: 468.98
                              - date: 2026-01-28T00:00:00+00:00
                                count: 1515.54
                              - date: 2026-01-29T00:00:00+00:00
                                count: 1497.24
                              - date: 2026-01-30T00:00:00+00:00
                                count: 1331.33
                              - date: 2026-01-31T00:00:00+00:00
                                count: 938.93
                              - date: 2026-02-01T00:00:00+00:00
                                count: 372.78
                              - date: 2026-02-02T00:00:00+00:00
                                count: 780.88
                              - date: 2026-02-03T00:00:00+00:00
                                count: 521.2
                              - date: 2026-02-04T00:00:00+00:00
                                count: 1409.73
                              - date: 2026-02-05T00:00:00+00:00
                                count: 1330.83
                              - date: 2026-02-06T00:00:00+00:00
                                count: 1504.63
                            items:
                              type: object
                              properties:
                                date:
                                  type: string
                                  example: 2026-01-07T00:00:00+00:00
                                count:
                                  type: number
                                  example: 846.54
                          total:
                            type: integer
                            example: 32131
                          delta:
                            type: number
                            example: -1.7
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 11270561
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Engagement / Messages
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Mass Messages (/api-reference/engagement-messages/mass-messages)

List sent mass messages with engagement stats (sent, viewed, purchased, etc.).

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/engagement/messages/mass-messages
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/engagement/messages/mass-messages:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Mass Messages
      operationId: massMessages
      description: List sent mass messages with engagement stats (sent, viewed,
        purchased, etc.).
      parameters:
        - in: query
          name: startDate
          description: The earliest message to retrieve. Keep empty to get all.
          example: 2026-01-07 00:00:00
          required: false
          schema:
            type: string
            description: The earliest message to retrieve. Keep empty to get all.
            example: 2026-01-07 00:00:00
        - in: query
          name: endDate
          description: The latest message to retrieve. Keep empty to get all. It must be
            after `startDate` and is also used for pagination.
          example: 2026-02-06 01:26:15
          required: false
          schema:
            type: string
            description: The latest message to retrieve. Keep empty to get all. It must be
              after `startDate` and is also used for pagination.
            example: 2026-02-06 01:26:15
        - in: query
          name: limit
          description: Number of messages to return (default = 10)
          example: 10
          required: false
          schema:
            type: integer
            description: Number of messages to return (default = 10)
            example: 10
        - in: query
          name: query
          description: Optionally, filter by message text.
          example: sciss
          required: false
          schema:
            type: string
            description: Optionally, filter by message text.
            example: sciss
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    hasMore: true
                    items:
                      - id: 1234567890
                        date: 2026-02-06T00:51:23+00:00
                        responseType: message
                        text: <p>Lets play ADULT ROCK-PAPER-SCISSORS babe, shall we?</p>
                        rawText: Lets play ADULT ROCK-PAPER-SCISSORS babe, shall we?
                        giphyId: null
                        isFree: true
                        isMediaReady: true
                        mediaCount: 0
                        media: []
                        previews: []
                        isTip: false
                        isReportedByMe: false
                        viewedCount: 203
                        sentCount: 68400
                        isCanceled: false
                        template: group
                        canUnsend: true
                        unsendSeconds: 1000000
                  _pagination:
                    next_page: https://app.onlyfansapi.com/api/acct_XXXXXXXXXX/engagement/messages/mass-messages?endDate=2026-02-05%2011%3A06%3A57&limit=10
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999959
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49988
                properties:
                  data:
                    type: object
                    properties:
                      hasMore:
                        type: boolean
                        example: true
                      items:
                        type: array
                        example:
                          - id: 1234567890
                            date: 2026-02-06T00:51:23+00:00
                            responseType: message
                            text: <p>Lets play ADULT ROCK-PAPER-SCISSORS babe, shall we?</p>
                            rawText: Lets play ADULT ROCK-PAPER-SCISSORS babe, shall we?
                            giphyId: null
                            isFree: true
                            isMediaReady: true
                            mediaCount: 0
                            media: []
                            previews: []
                            isTip: false
                            isReportedByMe: false
                            viewedCount: 203
                            sentCount: 68400
                            isCanceled: false
                            template: group
                            canUnsend: true
                            unsendSeconds: 1000000
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1234567890
                            date:
                              type: string
                              example: 2026-02-06T00:51:23+00:00
                            responseType:
                              type: string
                              example: message
                            text:
                              type: string
                              example: <p>Lets play ADULT ROCK-PAPER-SCISSORS babe, shall we?</p>
                            rawText:
                              type: string
                              example: Lets play ADULT ROCK-PAPER-SCISSORS babe, shall we?
                            giphyId:
                              type: string
                              example: null
                              nullable: true
                            isFree:
                              type: boolean
                              example: true
                            isMediaReady:
                              type: boolean
                              example: true
                            mediaCount:
                              type: integer
                              example: 0
                            media:
                              type: array
                              example: []
                            previews:
                              type: array
                              example: []
                            isTip:
                              type: boolean
                              example: false
                            isReportedByMe:
                              type: boolean
                              example: false
                            viewedCount:
                              type: integer
                              example: 203
                            sentCount:
                              type: integer
                              example: 68400
                            isCanceled:
                              type: boolean
                              example: false
                            template:
                              type: string
                              example: group
                            canUnsend:
                              type: boolean
                              example: true
                            unsendSeconds:
                              type: integer
                              example: 1000000
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: https://app.onlyfansapi.com/api/acct_XXXXXXXXXX/engagement/messages/mass-messages?endDate=2026-02-05%2011%3A06%3A57&limit=10
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999959
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49988
      tags:
        - Engagement / Messages
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Message Buyers (/api-reference/engagement-messages/message-buyers)

List buyers for a specific message.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/engagement/messages/{message_id}/buyers
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/engagement/messages/{message_id}/buyers:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: message_id
        description: The ID of the message.
        example: delectus
        required: true
        schema:
          type: string
    get:
      summary: Message Buyers
      operationId: messageBuyers
      description: List buyers for a specific message.
      parameters:
        - in: query
          name: limit
          description: Number of buyers to return (default = 10)
          example: 10
          required: false
          schema:
            type: integer
            description: Number of buyers to return (default = 10)
            example: 10
        - in: query
          name: offset
          description: Offset for pagination (default = 0)
          example: 0
          required: false
          schema:
            type: integer
            description: Offset for pagination (default = 0)
            example: 0
        - in: query
          name: skip_users_dups
          description: Skip duplicate users in results (0/1). Default = 1
          example: 1
          required: false
          schema:
            type: integer
            description: Skip duplicate users in results (0/1). Default = 1
            example: 1
        - in: query
          name: skip_users
          description: "Optional flag for subsequent pages (example: all)."
          example: all
          required: false
          schema:
            type: string
            description: "Optional flag for subsequent pages (example: all)."
            example: all
        - in: query
          name: marker
          description: Marker for pagination
          example: 0
          required: false
          schema:
            type: integer
            description: Marker for pagination
            example: 0
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - view: s
                        avatar: null
                        avatarThumbs: null
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 35777544
                        name: Newbles
                        username: u35777544
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: false
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: Doesnt rly like BJ
                        notice: Solo
                        isActive: true
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: true
                        subscribedByExpire: false
                        subscribedByExpireDate: 2033-05-03T05:32:54+00:00
                        subscribedByAutoprolong: true
                        subscribedIsExpiredNow: false
                        currentSubscribePrice: 0
                        subscribedOn: null
                        subscribedOnExpiredNow: true
                        subscribedOnDuration: 10 months
                        showMediaCount: true
                        lastSeen: 2026-02-05T16:10:14+00:00
                        canReport: true
                    marker: 957523925
                    hasMore: true
                  _pagination:
                    next_page: http://localhost/api/{account}/engagement/messages/34700613157/buyers?offset=10&limit=10&marker=957523925
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999959
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49988
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - view: s
                            avatar: null
                            avatarThumbs: null
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 35777544
                            name: Newbles
                            username: u35777544
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: false
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            displayName: Doesnt rly like BJ
                            notice: Solo
                            isActive: true
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: true
                            subscribedByExpire: false
                            subscribedByExpireDate: 2033-05-03T05:32:54+00:00
                            subscribedByAutoprolong: true
                            subscribedIsExpiredNow: false
                            currentSubscribePrice: 0
                            subscribedOn: null
                            subscribedOnExpiredNow: true
                            subscribedOnDuration: 10 months
                            showMediaCount: true
                            lastSeen: 2026-02-05T16:10:14+00:00
                            canReport: true
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: s
                            avatar:
                              type: string
                              example: null
                              nullable: true
                            avatarThumbs:
                              type: string
                              example: null
                              nullable: true
                            header:
                              type: string
                              example: null
                              nullable: true
                            headerSize:
                              type: string
                              example: null
                              nullable: true
                            headerThumbs:
                              type: string
                              example: null
                              nullable: true
                            id:
                              type: integer
                              example: 35777544
                            name:
                              type: string
                              example: Newbles
                            username:
                              type: string
                              example: u35777544
                            canLookStory:
                              type: boolean
                              example: false
                            canCommentStory:
                              type: boolean
                              example: false
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: false
                            canPayInternal:
                              type: boolean
                              example: false
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: false
                            tipsTextEnabled:
                              type: boolean
                              example: true
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: false
                            canAddSubscriber:
                              type: boolean
                              example: false
                            subscribePrice:
                              type: integer
                              example: 0
                            displayName:
                              type: string
                              example: Doesnt rly like BJ
                            notice:
                              type: string
                              example: Solo
                            isActive:
                              type: boolean
                              example: true
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: true
                            subscribedByExpire:
                              type: boolean
                              example: false
                            subscribedByExpireDate:
                              type: string
                              example: 2033-05-03T05:32:54+00:00
                            subscribedByAutoprolong:
                              type: boolean
                              example: true
                            subscribedIsExpiredNow:
                              type: boolean
                              example: false
                            currentSubscribePrice:
                              type: integer
                              example: 0
                            subscribedOn:
                              type: string
                              example: null
                              nullable: true
                            subscribedOnExpiredNow:
                              type: boolean
                              example: true
                            subscribedOnDuration:
                              type: string
                              example: 10 months
                            showMediaCount:
                              type: boolean
                              example: true
                            lastSeen:
                              type: string
                              example: 2026-02-05T16:10:14+00:00
                            canReport:
                              type: boolean
                              example: true
                      marker:
                        type: integer
                        example: 957523925
                      hasMore:
                        type: boolean
                        example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: http://localhost/api/{account}/engagement/messages/34700613157/buyers?offset=10&limit=10&marker=957523925
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999959
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49988
      tags:
        - Engagement / Messages
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Top Message (/api-reference/engagement-messages/top-message)

Get the top performing message by purchases in the selected timeframe.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/engagement/messages/top-message
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/engagement/messages/top-message:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Top Message
      operationId: topMessage
      description: Get the top performing message by purchases in the selected timeframe.
      parameters:
        - in: query
          name: startDate
          description: The start date for the period. Keep empty to retrieve from the
            model start date.
          example: 2026-01-07 00:00:00
          required: false
          schema:
            type: string
            description: The start date for the period. Keep empty to retrieve from the
              model start date.
            example: 2026-01-07 00:00:00
        - in: query
          name: endDate
          description: The end date for the period. Keep empty to retrieve until now. It
            must be after `startDate`.
          example: 2026-02-06 01:26:15
          required: false
          schema:
            type: string
            description: The end date for the period. Keep empty to retrieve until now. It
              must be after `startDate`.
            example: 2026-02-06 01:26:15
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    purchases:
                      id: 6677889900
                      date: 2024-06-30T12:53:42+00:00
                      responseType: message
                      text: This is the hardest i've ever been fucked... would you make me cum more
                        than this?? 🥵💦
                      rawText: This is the hardest i've ever been fucked... would you make me cum more
                        than this?? 🥵💦
                      giphyId: null
                      isFree: false
                      isMediaReady: true
                      mediaCount: 1
                      media:
                        - id: 7788990011
                          type: video
                          convertedToVideo: false
                          canView: true
                          hasError: false
                          createdAt: 2023-01-31T13:14:15+00:00
                          isReady: true
                          files:
                            full:
                              url: https://cdn.example.com/files/placeholder/video_source.mp4
                              width: 1080
                              height: 1920
                              size: 0
                              sources: []
                            thumb:
                              url: https://cdn.example.com/files/placeholder/thumb.jpg
                              width: 300
                              height: 300
                              size: 0
                            preview:
                              url: https://cdn.example.com/files/placeholder/preview.jpg
                              width: 960
                              height: 1707
                              size: 0
                            squarePreview:
                              url: https://cdn.example.com/files/placeholder/square.jpg
                              width: 960
                              height: 960
                              size: 0
                          duration: 528
                          hasCustomPreview: false
                          videoSources:
                            "240": https://cdn.example.com/files/placeholder/video_240p.mp4
                            "720": https://cdn.example.com/files/placeholder/video_720p.mp4
                      previews: []
                      isTip: false
                      isReportedByMe: false
                      viewedCount: 9360
                      sentCount: 15802
                      isCanceled: true
                      template: group
                      canUnsend: false
                      unsendSeconds: 0
                      price: "98.00"
                      purchasedCount: 146
                      canSendMessageToBuyers: true
                      totalRevenueGenerated: "14308.00"
                      relationships:
                        buyers:
                          href: https://app.onlyfansapi.com/api/acct_XXXXXXXXXX/engagement/messages/6677889900/buyers?limit=10&offset=0&skip_users_dups=1&marker=0
                          method: GET
                  _meta:
                    _credits:
                      used: 1
                      balance: 11335469
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      purchases:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 6677889900
                          date:
                            type: string
                            example: 2024-06-30T12:53:42+00:00
                          responseType:
                            type: string
                            example: message
                          text:
                            type: string
                            example: This is the hardest i've ever been fucked... would you make me cum more
                              than this?? 🥵💦
                          rawText:
                            type: string
                            example: This is the hardest i've ever been fucked... would you make me cum more
                              than this?? 🥵💦
                          giphyId:
                            type: string
                            example: null
                            nullable: true
                          isFree:
                            type: boolean
                            example: false
                          isMediaReady:
                            type: boolean
                            example: true
                          mediaCount:
                            type: integer
                            example: 1
                          media:
                            type: array
                            example:
                              - id: 7788990011
                                type: video
                                convertedToVideo: false
                                canView: true
                                hasError: false
                                createdAt: 2023-01-31T13:14:15+00:00
                                isReady: true
                                files:
                                  full:
                                    url: https://cdn.example.com/files/placeholder/video_source.mp4
                                    width: 1080
                                    height: 1920
                                    size: 0
                                    sources: []
                                  thumb:
                                    url: https://cdn.example.com/files/placeholder/thumb.jpg
                                    width: 300
                                    height: 300
                                    size: 0
                                  preview:
                                    url: https://cdn.example.com/files/placeholder/preview.jpg
                                    width: 960
                                    height: 1707
                                    size: 0
                                  squarePreview:
                                    url: https://cdn.example.com/files/placeholder/square.jpg
                                    width: 960
                                    height: 960
                                    size: 0
                                duration: 528
                                hasCustomPreview: false
                                videoSources:
                                  "240": https://cdn.example.com/files/placeholder/video_240p.mp4
                                  "720": https://cdn.example.com/files/placeholder/video_720p.mp4
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 7788990011
                                type:
                                  type: string
                                  example: video
                                convertedToVideo:
                                  type: boolean
                                  example: false
                                canView:
                                  type: boolean
                                  example: true
                                hasError:
                                  type: boolean
                                  example: false
                                createdAt:
                                  type: string
                                  example: 2023-01-31T13:14:15+00:00
                                isReady:
                                  type: boolean
                                  example: true
                                files:
                                  type: object
                                  properties:
                                    full:
                                      type: object
                                      properties:
                                        url:
                                          type: string
                                          example: https://cdn.example.com/files/placeholder/video_source.mp4
                                        width:
                                          type: integer
                                          example: 1080
                                        height:
                                          type: integer
                                          example: 1920
                                        size:
                                          type: integer
                                          example: 0
                                        sources:
                                          type: array
                                          example: []
                                    thumb:
                                      type: object
                                      properties:
                                        url:
                                          type: string
                                          example: https://cdn.example.com/files/placeholder/thumb.jpg
                                        width:
                                          type: integer
                                          example: 300
                                        height:
                                          type: integer
                                          example: 300
                                        size:
                                          type: integer
                                          example: 0
                                    preview:
                                      type: object
                                      properties:
                                        url:
                                          type: string
                                          example: https://cdn.example.com/files/placeholder/preview.jpg
                                        width:
                                          type: integer
                                          example: 960
                                        height:
                                          type: integer
                                          example: 1707
                                        size:
                                          type: integer
                                          example: 0
                                    squarePreview:
                                      type: object
                                      properties:
                                        url:
                                          type: string
                                          example: https://cdn.example.com/files/placeholder/square.jpg
                                        width:
                                          type: integer
                                          example: 960
                                        height:
                                          type: integer
                                          example: 960
                                        size:
                                          type: integer
                                          example: 0
                                duration:
                                  type: integer
                                  example: 528
                                hasCustomPreview:
                                  type: boolean
                                  example: false
                                videoSources:
                                  type: object
                                  properties:
                                    "240":
                                      type: string
                                      example: https://cdn.example.com/files/placeholder/video_240p.mp4
                                    "720":
                                      type: string
                                      example: https://cdn.example.com/files/placeholder/video_720p.mp4
                          previews:
                            type: array
                            example: []
                          isTip:
                            type: boolean
                            example: false
                          isReportedByMe:
                            type: boolean
                            example: false
                          viewedCount:
                            type: integer
                            example: 9360
                          sentCount:
                            type: integer
                            example: 15802
                          isCanceled:
                            type: boolean
                            example: true
                          template:
                            type: string
                            example: group
                          canUnsend:
                            type: boolean
                            example: false
                          unsendSeconds:
                            type: integer
                            example: 0
                          price:
                            type: string
                            example: "98.00"
                          purchasedCount:
                            type: integer
                            example: 146
                          canSendMessageToBuyers:
                            type: boolean
                            example: true
                          totalRevenueGenerated:
                            type: string
                            example: "14308.00"
                          relationships:
                            type: object
                            properties:
                              buyers:
                                type: object
                                properties:
                                  href:
                                    type: string
                                    example: https://app.onlyfansapi.com/api/acct_XXXXXXXXXX/engagement/messages/6677889900/buyers?limit=10&offset=0&skip_users_dups=1&marker=0
                                  method:
                                    type: string
                                    example: GET
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 11335469
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Engagement / Messages
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Create Custom Summary Category (/api-reference/fans-ai-summary/create-custom-summary-category)

Create a custom fan summary category for your Team (max 10). The category label becomes an additional field in every subsequently generated fan summary, and the keywords are used to retrieve matching fan messages.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/fan-summary-categories
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/fan-summary-categories:
    post:
      summary: Create Custom Summary Category
      operationId: createCustomSummaryCategory
      description: Create a custom fan summary category for your Team (max 10). The
        category label becomes an additional field in every subsequently
        generated fan summary, and the keywords are used to retrieve matching
        fan messages.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: fan_cat_abc123
                    key: custom_gift_preferences
                    label: Gift Preferences
                    keywords: gift, wishlist, amazon, spoil, surprise, present
                    created_at: 2026-07-17T12:00:00.000000Z
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: fan_cat_abc123
                      key:
                        type: string
                        example: custom_gift_preferences
                      label:
                        type: string
                        example: Gift Preferences
                      keywords:
                        type: string
                        example: gift, wishlist, amazon, spoil, surprise, present
                      created_at:
                        type: string
                        example: 2026-07-17T12:00:00.000000Z
      tags:
        - Fans - AI Summary
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                label:
                  type: string
                  description: Display label for the category. Also determines the immutable field
                    key in summary_data (e.g. "Gift Preferences" becomes
                    custom_gift_preferences).
                  example: Gift Preferences
                keywords:
                  type: string
                  description: Comma-separated keywords used to find relevant fan messages for
                    this category.
                  example: gift, wishlist, amazon, spoil, surprise, present
              required:
                - label
                - keywords
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Delete Custom Summary Category (/api-reference/fans-ai-summary/delete-custom-summary-category)

Delete a custom fan summary category. Existing summaries keep any previously extracted data for this category; new summaries will no longer include it.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/fan-summary-categories/{category_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/fan-summary-categories/{category_id}:
    parameters:
      - in: path
        name: category_id
        description: The ID of the category
        example: fan_cat_abc123
        required: true
        schema:
          type: string
    delete:
      summary: Delete Custom Summary Category
      operationId: deleteCustomSummaryCategory
      description: Delete a custom fan summary category. Existing summaries keep any
        previously extracted data for this category; new summaries will no
        longer include it.
      parameters: []
      responses:
        "204":
          description: Successfully deleted
          content:
            application/json:
              schema:
                type: object
                nullable: true
      tags:
        - Fans - AI Summary
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Generate Fan Summary (/api-reference/fans-ai-summary/generate-fan-summary)

Queue generation or regeneration of an AI profile summary for a fan. Costs 200 credits (charged on completion). Use the GET endpoint to poll for results. To regenerate an existing summary, pass `regenerate: true`.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/fans/{fan_id}/summary
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/fans/{fan_id}/summary:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: fan_id
        description: Fan's OnlyFans ID
        example: 123456789
        required: true
        schema:
          type: string
    post:
      summary: Generate Fan Summary
      operationId: generateFanSummary
      description: "Queue generation or regeneration of an AI profile summary for a
        fan. Costs 200 credits (charged on completion). Use the GET endpoint to
        poll for results. To regenerate an existing summary, pass `regenerate:
        true`."
      parameters: []
      responses:
        "200":
          description: Generation queued
          content:
            application/json:
              schema:
                type: object
                example:
                  status: processing
                  message: Fan summary generation has been queued. Use GET to poll for results.
                properties:
                  status:
                    type: string
                    example: processing
                  message:
                    type: string
                    example: Fan summary generation has been queued. Use GET to poll for results.
      tags:
        - Fans - AI Summary
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                regenerate:
                  type: boolean
                  description: Set to true to regenerate an existing completed summary.
                  example: true
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Fan Summary (/api-reference/fans-ai-summary/get-fan-summary)

Retrieve the AI profile summary for a fan. Poll this endpoint after triggering a generation to check for completion.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/fans/{fan_id}/summary
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/fans/{fan_id}/summary:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: fan_id
        description: Fan's OnlyFans ID
        example: 123456789
        required: true
        schema:
          type: string
    get:
      summary: Get Fan Summary
      operationId: getFanSummary
      description: Retrieve the AI profile summary for a fan. Poll this endpoint after
        triggering a generation to check for completion.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  status: completed
                  summary_data:
                    name: Jane Doe
                    preferred_name: Jane
                    family_pets: Has a golden retriever named Max
                    travel_plans: Planning a trip to Bali
                    kinks: ""
                    hobbies: Yoga, photography
                    content_preferences: Behind the scenes content
                    content_dislikes: Not into feet content
                    themes: ""
                    requests: ""
                    interests: Fitness, travel
                    other_notes: ""
                    spend_cadence: Mostly tips on Fridays; said he can't buy anything this month
                      anymore — June
                    dos_and_donts: Never mention his wife
                  analyzed_message_count: 42
                  last_analyzed_at: 2026-03-19T12:00:00+00:00
                  last_buy_date: 2026-03-15T18:30:00+00:00
                  error_message: null
                  custom_fields:
                    - key: custom_gift_preferences
                      label: Gift Preferences
                properties:
                  status:
                    type: string
                    example: completed
                  summary_data:
                    type: object
                    properties:
                      name:
                        type: string
                        example: Jane Doe
                      preferred_name:
                        type: string
                        example: Jane
                      family_pets:
                        type: string
                        example: Has a golden retriever named Max
                      travel_plans:
                        type: string
                        example: Planning a trip to Bali
                      kinks:
                        type: string
                        example: ""
                      hobbies:
                        type: string
                        example: Yoga, photography
                      content_preferences:
                        type: string
                        example: Behind the scenes content
                      content_dislikes:
                        type: string
                        example: Not into feet content
                      themes:
                        type: string
                        example: ""
                      requests:
                        type: string
                        example: ""
                      interests:
                        type: string
                        example: Fitness, travel
                      other_notes:
                        type: string
                        example: ""
                      spend_cadence:
                        type: string
                        example: Mostly tips on Fridays; said he can't buy anything this month anymore —
                          June
                      dos_and_donts:
                        type: string
                        example: Never mention his wife
                  analyzed_message_count:
                    type: integer
                    example: 42
                  last_analyzed_at:
                    type: string
                    example: 2026-03-19T12:00:00+00:00
                  last_buy_date:
                    type: string
                    example: 2026-03-15T18:30:00+00:00
                  error_message:
                    type: string
                    example: null
                    nullable: true
                  custom_fields:
                    type: array
                    example:
                      - key: custom_gift_preferences
                        label: Gift Preferences
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                          example: custom_gift_preferences
                        label:
                          type: string
                          example: Gift Preferences
      tags:
        - Fans - AI Summary
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Custom Summary Categories (/api-reference/fans-ai-summary/list-custom-summary-categories)

Retrieve the custom fan summary categories defined for your Team. Custom categories are extracted as additional fields in every generated fan summary.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/fan-summary-categories
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/fan-summary-categories:
    get:
      summary: List Custom Summary Categories
      operationId: listCustomSummaryCategories
      description: Retrieve the custom fan summary categories defined for your Team.
        Custom categories are extracted as additional fields in every generated
        fan summary.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - id: fan_cat_abc123
                      key: custom_gift_preferences
                      label: Gift Preferences
                      keywords: gift, wishlist, amazon, spoil, surprise, present
                      created_at: 2026-07-17T12:00:00.000000Z
                properties:
                  data:
                    type: array
                    example:
                      - id: fan_cat_abc123
                        key: custom_gift_preferences
                        label: Gift Preferences
                        keywords: gift, wishlist, amazon, spoil, surprise, present
                        created_at: 2026-07-17T12:00:00.000000Z
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: fan_cat_abc123
                        key:
                          type: string
                          example: custom_gift_preferences
                        label:
                          type: string
                          example: Gift Preferences
                        keywords:
                          type: string
                          example: gift, wishlist, amazon, spoil, surprise, present
                        created_at:
                          type: string
                          example: 2026-07-17T12:00:00.000000Z
      tags:
        - Fans - AI Summary
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Update Custom Summary Category (/api-reference/fans-ai-summary/update-custom-summary-category)

Update the label or keywords of a custom fan summary category. The field key is immutable so existing summaries keep their data.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml put /api/fan-summary-categories/{category_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/fan-summary-categories/{category_id}:
    parameters:
      - in: path
        name: category_id
        description: The ID of the category
        example: fan_cat_abc123
        required: true
        schema:
          type: string
    put:
      summary: Update Custom Summary Category
      operationId: updateCustomSummaryCategory
      description: Update the label or keywords of a custom fan summary category. The
        field key is immutable so existing summaries keep their data.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: fan_cat_abc123
                    key: custom_gift_preferences
                    label: Gift Preferences
                    keywords: gift, wishlist, amazon, spoil, surprise, present
                    created_at: 2026-07-17T12:00:00.000000Z
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: fan_cat_abc123
                      key:
                        type: string
                        example: custom_gift_preferences
                      label:
                        type: string
                        example: Gift Preferences
                      keywords:
                        type: string
                        example: gift, wishlist, amazon, spoil, surprise, present
                      created_at:
                        type: string
                        example: 2026-07-17T12:00:00.000000Z
      tags:
        - Fans - AI Summary
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                label:
                  type: string
                  description: Display label for the category.
                  example: Gift Preferences
                keywords:
                  type: string
                  description: Comma-separated keywords used to find relevant fan messages for
                    this category.
                  example: gift, wishlist, amazon, spoil, surprise, present
              required:
                - label
                - keywords
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Active Followings (/api-reference/following/list-active-followings)

Get a paginated list of followings for an Account. Newest followings are first.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/following/active
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/following/active:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Active Followings
      operationId: listActiveFollowings
      description: Get a paginated list of followings for an Account. Newest
        followings are first.
      parameters:
        - in: query
          name: limit
          description: Number of followings to return (1-50). Must be at least 1. Must not
            be greater than 50.
          example: 10
          required: false
          schema:
            type: integer
            description: Number of followings to return (1-50). Must be at least 1. Must not
              be greater than 50.
            example: 10
        - in: query
          name: offset
          description: Pagination offset. Must be at least 0.
          example: 0
          required: false
          schema:
            type: integer
            description: Pagination offset. Must be at least 0.
            example: 0
        - in: query
          name: query
          description: Search within following name/username.
          example: john
          required: false
          schema:
            type: string
            description: Search within following name/username.
            example: john
            nullable: true
        - in: query
          name: filter
          description: ""
          example: []
          required: false
          schema:
            type: object
            description: ""
            example: []
            properties: {}
        - in: query
          name: filter.online
          description: Filter by online status (1 for online, 0 for offline, null for all).
          example: 1
          required: false
          schema:
            type: integer
            description: Filter by online status (1 for online, 0 for offline, null for
              all).
            example: 1
            enum:
              - 1
              - 0
            nullable: true
        - in: query
          name: filter.paid
          description: Filter by paid status (1 for paid, 0 for free, null for all).
          example: 1
          required: false
          schema:
            type: integer
            description: Filter by paid status (1 for paid, 0 for free, null for all).
            example: 1
            enum:
              - 1
              - 0
            nullable: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - view: x
                        avatar: https://public.onlyfans.com/files/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                        avatarThumbs:
                          c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                          c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                        header: https://public.onlyfans.com/files/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                        headerSize:
                          width: 4868
                          height: 851
                        headerThumbs:
                          w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                          w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                        id: 254
                        name: OnlyFans Creators
                        username: onlyfanscreators
                        canLookStory: true
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: true
                        canPayInternal: true
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: true
                        tipsTextEnabled: false
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: true
                        canAddSubscriber: false
                        subscribePrice: 0
                        isPaywallRequired: true
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: true
                        subscribedByExpire: false
                        subscribedByExpireDate: 2025-01-01T00:00:00+00:00
                        subscribedByAutoprolong: true
                        subscribedIsExpiredNow: false
                        currentSubscribePrice: 0
                        subscribedOn: false
                        subscribedOnExpiredNow: null
                        subscribedOnDuration: null
                        listsStates:
                          - id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                        canReport: false
                        canReceiveChatMessage: false
                        hideChat: false
                        lastSeen: null
                        isPerformer: true
                        isRealPerformer: true
                        subscribedByData:
                          price: 0
                          newPrice: 0
                          regularPrice: 0
                          subscribePrice: 0
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: 2025-01-01T00:00:00+00:00
                          expiredAt: 2025-01-01T00:00:00+00:00
                          renewedAt: 2025-01-01T00:00:00+00:00
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: null
                          isMuted: false
                          unsubscribeReason: No reason given
                          duration: 4 months
                          showPostsInFeed: true
                          subscribes:
                            - id: 123
                              userId: 254
                              subscriberId: 123
                              date: 2025-01-01T00:00:00+00:00
                              duration: 3652
                              startDate: 2025-01-01T00:00:00+00:00
                              expireDate: 2025-01-01T00:00:00+00:00
                              cancelDate: null
                              price: 0
                              regularPrice: 0
                              discount: 0
                              earningId: 0
                              action: subscribe
                              type: auto
                              offerStart: null
                              offerEnd: null
                              isCurrent: true
                          hasActivePaidSubscriptions: false
                        subscribedOnData: null
                        canTrialSend: false
                        isBlocked: false
                        canUnsubscribe: true
                        isPendingAutoprolong: false
                    hasMore: true
                  _pagination:
                    next_page: https://app.onlyfansapi.com/api/acct_abc123/following/active?offset=10&limit=10
                  _meta:
                    _credits:
                      used: 1
                      balance: 999971
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49994
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - view: x
                            avatar: https://public.onlyfans.com/files/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                            avatarThumbs:
                              c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                              c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                            header: https://public.onlyfans.com/files/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                            headerSize:
                              width: 4868
                              height: 851
                            headerThumbs:
                              w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                              w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                            id: 254
                            name: OnlyFans Creators
                            username: onlyfanscreators
                            canLookStory: true
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: true
                            canPayInternal: true
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: true
                            tipsTextEnabled: false
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: true
                            canAddSubscriber: false
                            subscribePrice: 0
                            isPaywallRequired: true
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: true
                            subscribedByExpire: false
                            subscribedByExpireDate: 2025-01-01T00:00:00+00:00
                            subscribedByAutoprolong: true
                            subscribedIsExpiredNow: false
                            currentSubscribePrice: 0
                            subscribedOn: false
                            subscribedOnExpiredNow: null
                            subscribedOnDuration: null
                            listsStates:
                              - id: following
                                type: following
                                name: Following
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                            canReport: false
                            canReceiveChatMessage: false
                            hideChat: false
                            lastSeen: null
                            isPerformer: true
                            isRealPerformer: true
                            subscribedByData:
                              price: 0
                              newPrice: 0
                              regularPrice: 0
                              subscribePrice: 0
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: 2025-01-01T00:00:00+00:00
                              expiredAt: 2025-01-01T00:00:00+00:00
                              renewedAt: 2025-01-01T00:00:00+00:00
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: null
                              isMuted: false
                              unsubscribeReason: No reason given
                              duration: 4 months
                              showPostsInFeed: true
                              subscribes:
                                - id: 123
                                  userId: 254
                                  subscriberId: 123
                                  date: 2025-01-01T00:00:00+00:00
                                  duration: 3652
                                  startDate: 2025-01-01T00:00:00+00:00
                                  expireDate: 2025-01-01T00:00:00+00:00
                                  cancelDate: null
                                  price: 0
                                  regularPrice: 0
                                  discount: 0
                                  earningId: 0
                                  action: subscribe
                                  type: auto
                                  offerStart: null
                                  offerEnd: null
                                  isCurrent: true
                              hasActivePaidSubscriptions: false
                            subscribedOnData: null
                            canTrialSend: false
                            isBlocked: false
                            canUnsubscribe: true
                            isPendingAutoprolong: false
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: x
                            avatar:
                              type: string
                              example: https://public.onlyfans.com/files/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/c50/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                                c144:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/c144/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                            header:
                              type: string
                              example: https://public.onlyfans.com/files/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                            headerSize:
                              type: object
                              properties:
                                width:
                                  type: integer
                                  example: 4868
                                height:
                                  type: integer
                                  example: 851
                            headerThumbs:
                              type: object
                              properties:
                                w480:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/w480/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                                w760:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/w760/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                            id:
                              type: integer
                              example: 254
                            name:
                              type: string
                              example: OnlyFans Creators
                            username:
                              type: string
                              example: onlyfanscreators
                            canLookStory:
                              type: boolean
                              example: true
                            canCommentStory:
                              type: boolean
                              example: false
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: true
                            canPayInternal:
                              type: boolean
                              example: true
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: true
                            tipsTextEnabled:
                              type: boolean
                              example: false
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: true
                            canAddSubscriber:
                              type: boolean
                              example: false
                            subscribePrice:
                              type: integer
                              example: 0
                            isPaywallRequired:
                              type: boolean
                              example: true
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: true
                            subscribedByExpire:
                              type: boolean
                              example: false
                            subscribedByExpireDate:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            subscribedByAutoprolong:
                              type: boolean
                              example: true
                            subscribedIsExpiredNow:
                              type: boolean
                              example: false
                            currentSubscribePrice:
                              type: integer
                              example: 0
                            subscribedOn:
                              type: boolean
                              example: false
                            subscribedOnExpiredNow:
                              type: string
                              example: null
                              nullable: true
                            subscribedOnDuration:
                              type: string
                              example: null
                              nullable: true
                            listsStates:
                              type: array
                              example:
                                - id: following
                                  type: following
                                  name: Following
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: following
                                  type:
                                    type: string
                                    example: following
                                  name:
                                    type: string
                                    example: Following
                                  hasUser:
                                    type: boolean
                                    example: true
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: ALREADY_EXISTS
                            canReport:
                              type: boolean
                              example: false
                            canReceiveChatMessage:
                              type: boolean
                              example: false
                            hideChat:
                              type: boolean
                              example: false
                            lastSeen:
                              type: string
                              example: null
                              nullable: true
                            isPerformer:
                              type: boolean
                              example: true
                            isRealPerformer:
                              type: boolean
                              example: true
                            subscribedByData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: integer
                                  example: 0
                                subscribePrice:
                                  type: integer
                                  example: 0
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                expiredAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                renewedAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                discountFinishedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                discountStartedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                status:
                                  type: string
                                  example: null
                                  nullable: true
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: No reason given
                                duration:
                                  type: string
                                  example: 4 months
                                showPostsInFeed:
                                  type: boolean
                                  example: true
                                subscribes:
                                  type: array
                                  example:
                                    - id: 123
                                      userId: 254
                                      subscriberId: 123
                                      date: 2025-01-01T00:00:00+00:00
                                      duration: 3652
                                      startDate: 2025-01-01T00:00:00+00:00
                                      expireDate: 2025-01-01T00:00:00+00:00
                                      cancelDate: null
                                      price: 0
                                      regularPrice: 0
                                      discount: 0
                                      earningId: 0
                                      action: subscribe
                                      type: auto
                                      offerStart: null
                                      offerEnd: null
                                      isCurrent: true
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                        example: 123
                                      userId:
                                        type: integer
                                        example: 254
                                      subscriberId:
                                        type: integer
                                        example: 123
                                      date:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      duration:
                                        type: integer
                                        example: 3652
                                      startDate:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      expireDate:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      cancelDate:
                                        type: string
                                        example: null
                                        nullable: true
                                      price:
                                        type: integer
                                        example: 0
                                      regularPrice:
                                        type: integer
                                        example: 0
                                      discount:
                                        type: integer
                                        example: 0
                                      earningId:
                                        type: integer
                                        example: 0
                                      action:
                                        type: string
                                        example: subscribe
                                      type:
                                        type: string
                                        example: auto
                                      offerStart:
                                        type: string
                                        example: null
                                        nullable: true
                                      offerEnd:
                                        type: string
                                        example: null
                                        nullable: true
                                      isCurrent:
                                        type: boolean
                                        example: true
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            subscribedOnData:
                              type: string
                              example: null
                              nullable: true
                            canTrialSend:
                              type: boolean
                              example: false
                            isBlocked:
                              type: boolean
                              example: false
                            canUnsubscribe:
                              type: boolean
                              example: true
                            isPendingAutoprolong:
                              type: boolean
                              example: false
                      hasMore:
                        type: boolean
                        example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: https://app.onlyfansapi.com/api/acct_abc123/following/active?offset=10&limit=10
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999971
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49994
      tags:
        - Following
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List All Followings (/api-reference/following/list-all-followings)

Get a paginated list of followings for an Account. Newest followings are first.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/following/all
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/following/all:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List All Followings
      operationId: listAllFollowings
      description: Get a paginated list of followings for an Account. Newest
        followings are first.
      parameters:
        - in: query
          name: limit
          description: Number of followings to return (1-50). Must be at least 1. Must not
            be greater than 50.
          example: 10
          required: false
          schema:
            type: integer
            description: Number of followings to return (1-50). Must be at least 1. Must not
              be greater than 50.
            example: 10
        - in: query
          name: offset
          description: Pagination offset. Must be at least 0.
          example: 0
          required: false
          schema:
            type: integer
            description: Pagination offset. Must be at least 0.
            example: 0
        - in: query
          name: query
          description: Search within following name/username.
          example: john
          required: false
          schema:
            type: string
            description: Search within following name/username.
            example: john
            nullable: true
        - in: query
          name: filter
          description: ""
          example: []
          required: false
          schema:
            type: object
            description: ""
            example: []
            properties: {}
        - in: query
          name: filter.online
          description: Filter by online status (1 for online, 0 for offline, null for all).
          example: 1
          required: false
          schema:
            type: integer
            description: Filter by online status (1 for online, 0 for offline, null for
              all).
            example: 1
            enum:
              - 1
              - 0
            nullable: true
        - in: query
          name: filter.paid
          description: Filter by paid status (1 for paid, 0 for free, null for all).
          example: 1
          required: false
          schema:
            type: integer
            description: Filter by paid status (1 for paid, 0 for free, null for all).
            example: 1
            enum:
              - 1
              - 0
            nullable: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - view: x
                        avatar: https://public.onlyfans.com/files/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                        avatarThumbs:
                          c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                          c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                        header: https://public.onlyfans.com/files/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                        headerSize:
                          width: 4868
                          height: 851
                        headerThumbs:
                          w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                          w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                        id: 254
                        name: OnlyFans Creators
                        username: onlyfanscreators
                        canLookStory: true
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: true
                        canPayInternal: true
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: true
                        tipsTextEnabled: false
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: true
                        canAddSubscriber: false
                        subscribePrice: 0
                        isPaywallRequired: true
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: true
                        subscribedByExpire: false
                        subscribedByExpireDate: 2025-01-01T00:00:00+00:00
                        subscribedByAutoprolong: true
                        subscribedIsExpiredNow: false
                        currentSubscribePrice: 0
                        subscribedOn: false
                        subscribedOnExpiredNow: null
                        subscribedOnDuration: null
                        listsStates:
                          - id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                        canReport: false
                        canReceiveChatMessage: false
                        hideChat: false
                        lastSeen: null
                        isPerformer: true
                        isRealPerformer: true
                        subscribedByData:
                          price: 0
                          newPrice: 0
                          regularPrice: 0
                          subscribePrice: 0
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: 2025-01-01T00:00:00+00:00
                          expiredAt: 2025-01-01T00:00:00+00:00
                          renewedAt: 2025-01-01T00:00:00+00:00
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: null
                          isMuted: false
                          unsubscribeReason: No reason given
                          duration: 4 months
                          showPostsInFeed: true
                          subscribes:
                            - id: 123
                              userId: 254
                              subscriberId: 123
                              date: 2025-01-01T00:00:00+00:00
                              duration: 3652
                              startDate: 2025-01-01T00:00:00+00:00
                              expireDate: 2025-01-01T00:00:00+00:00
                              cancelDate: null
                              price: 0
                              regularPrice: 0
                              discount: 0
                              earningId: 0
                              action: subscribe
                              type: auto
                              offerStart: null
                              offerEnd: null
                              isCurrent: true
                          hasActivePaidSubscriptions: false
                        subscribedOnData: null
                        canTrialSend: false
                        isBlocked: false
                        canUnsubscribe: true
                        isPendingAutoprolong: false
                    hasMore: true
                  _pagination:
                    next_page: https://app.onlyfansapi.com/api/acct_abc123/following/all?offset=10&limit=10
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999988
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49942
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - view: x
                            avatar: https://public.onlyfans.com/files/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                            avatarThumbs:
                              c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                              c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                            header: https://public.onlyfans.com/files/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                            headerSize:
                              width: 4868
                              height: 851
                            headerThumbs:
                              w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                              w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                            id: 254
                            name: OnlyFans Creators
                            username: onlyfanscreators
                            canLookStory: true
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: true
                            canPayInternal: true
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: true
                            tipsTextEnabled: false
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: true
                            canAddSubscriber: false
                            subscribePrice: 0
                            isPaywallRequired: true
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: true
                            subscribedByExpire: false
                            subscribedByExpireDate: 2025-01-01T00:00:00+00:00
                            subscribedByAutoprolong: true
                            subscribedIsExpiredNow: false
                            currentSubscribePrice: 0
                            subscribedOn: false
                            subscribedOnExpiredNow: null
                            subscribedOnDuration: null
                            listsStates:
                              - id: following
                                type: following
                                name: Following
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                            canReport: false
                            canReceiveChatMessage: false
                            hideChat: false
                            lastSeen: null
                            isPerformer: true
                            isRealPerformer: true
                            subscribedByData:
                              price: 0
                              newPrice: 0
                              regularPrice: 0
                              subscribePrice: 0
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: 2025-01-01T00:00:00+00:00
                              expiredAt: 2025-01-01T00:00:00+00:00
                              renewedAt: 2025-01-01T00:00:00+00:00
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: null
                              isMuted: false
                              unsubscribeReason: No reason given
                              duration: 4 months
                              showPostsInFeed: true
                              subscribes:
                                - id: 123
                                  userId: 254
                                  subscriberId: 123
                                  date: 2025-01-01T00:00:00+00:00
                                  duration: 3652
                                  startDate: 2025-01-01T00:00:00+00:00
                                  expireDate: 2025-01-01T00:00:00+00:00
                                  cancelDate: null
                                  price: 0
                                  regularPrice: 0
                                  discount: 0
                                  earningId: 0
                                  action: subscribe
                                  type: auto
                                  offerStart: null
                                  offerEnd: null
                                  isCurrent: true
                              hasActivePaidSubscriptions: false
                            subscribedOnData: null
                            canTrialSend: false
                            isBlocked: false
                            canUnsubscribe: true
                            isPendingAutoprolong: false
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: x
                            avatar:
                              type: string
                              example: https://public.onlyfans.com/files/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/c50/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                                c144:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/c144/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                            header:
                              type: string
                              example: https://public.onlyfans.com/files/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                            headerSize:
                              type: object
                              properties:
                                width:
                                  type: integer
                                  example: 4868
                                height:
                                  type: integer
                                  example: 851
                            headerThumbs:
                              type: object
                              properties:
                                w480:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/w480/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                                w760:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/w760/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                            id:
                              type: integer
                              example: 254
                            name:
                              type: string
                              example: OnlyFans Creators
                            username:
                              type: string
                              example: onlyfanscreators
                            canLookStory:
                              type: boolean
                              example: true
                            canCommentStory:
                              type: boolean
                              example: false
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: true
                            canPayInternal:
                              type: boolean
                              example: true
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: true
                            tipsTextEnabled:
                              type: boolean
                              example: false
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: true
                            canAddSubscriber:
                              type: boolean
                              example: false
                            subscribePrice:
                              type: integer
                              example: 0
                            isPaywallRequired:
                              type: boolean
                              example: true
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: true
                            subscribedByExpire:
                              type: boolean
                              example: false
                            subscribedByExpireDate:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            subscribedByAutoprolong:
                              type: boolean
                              example: true
                            subscribedIsExpiredNow:
                              type: boolean
                              example: false
                            currentSubscribePrice:
                              type: integer
                              example: 0
                            subscribedOn:
                              type: boolean
                              example: false
                            subscribedOnExpiredNow:
                              type: string
                              example: null
                              nullable: true
                            subscribedOnDuration:
                              type: string
                              example: null
                              nullable: true
                            listsStates:
                              type: array
                              example:
                                - id: following
                                  type: following
                                  name: Following
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: following
                                  type:
                                    type: string
                                    example: following
                                  name:
                                    type: string
                                    example: Following
                                  hasUser:
                                    type: boolean
                                    example: true
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: ALREADY_EXISTS
                            canReport:
                              type: boolean
                              example: false
                            canReceiveChatMessage:
                              type: boolean
                              example: false
                            hideChat:
                              type: boolean
                              example: false
                            lastSeen:
                              type: string
                              example: null
                              nullable: true
                            isPerformer:
                              type: boolean
                              example: true
                            isRealPerformer:
                              type: boolean
                              example: true
                            subscribedByData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: integer
                                  example: 0
                                subscribePrice:
                                  type: integer
                                  example: 0
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                expiredAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                renewedAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                discountFinishedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                discountStartedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                status:
                                  type: string
                                  example: null
                                  nullable: true
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: No reason given
                                duration:
                                  type: string
                                  example: 4 months
                                showPostsInFeed:
                                  type: boolean
                                  example: true
                                subscribes:
                                  type: array
                                  example:
                                    - id: 123
                                      userId: 254
                                      subscriberId: 123
                                      date: 2025-01-01T00:00:00+00:00
                                      duration: 3652
                                      startDate: 2025-01-01T00:00:00+00:00
                                      expireDate: 2025-01-01T00:00:00+00:00
                                      cancelDate: null
                                      price: 0
                                      regularPrice: 0
                                      discount: 0
                                      earningId: 0
                                      action: subscribe
                                      type: auto
                                      offerStart: null
                                      offerEnd: null
                                      isCurrent: true
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                        example: 123
                                      userId:
                                        type: integer
                                        example: 254
                                      subscriberId:
                                        type: integer
                                        example: 123
                                      date:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      duration:
                                        type: integer
                                        example: 3652
                                      startDate:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      expireDate:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      cancelDate:
                                        type: string
                                        example: null
                                        nullable: true
                                      price:
                                        type: integer
                                        example: 0
                                      regularPrice:
                                        type: integer
                                        example: 0
                                      discount:
                                        type: integer
                                        example: 0
                                      earningId:
                                        type: integer
                                        example: 0
                                      action:
                                        type: string
                                        example: subscribe
                                      type:
                                        type: string
                                        example: auto
                                      offerStart:
                                        type: string
                                        example: null
                                        nullable: true
                                      offerEnd:
                                        type: string
                                        example: null
                                        nullable: true
                                      isCurrent:
                                        type: boolean
                                        example: true
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            subscribedOnData:
                              type: string
                              example: null
                              nullable: true
                            canTrialSend:
                              type: boolean
                              example: false
                            isBlocked:
                              type: boolean
                              example: false
                            canUnsubscribe:
                              type: boolean
                              example: true
                            isPendingAutoprolong:
                              type: boolean
                              example: false
                      hasMore:
                        type: boolean
                        example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: https://app.onlyfansapi.com/api/acct_abc123/following/all?offset=10&limit=10
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999988
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49942
      tags:
        - Following
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Expired Followings (/api-reference/following/list-expired-followings)

Get a paginated list of expired followings for an Account. Newest followings are first.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/following/expired
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/following/expired:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Expired Followings
      operationId: listExpiredFollowings
      description: Get a paginated list of expired followings for an Account. Newest
        followings are first.
      parameters:
        - in: query
          name: limit
          description: Number of followings to return (1-50). Must be at least 1. Must not
            be greater than 50.
          example: 10
          required: false
          schema:
            type: integer
            description: Number of followings to return (1-50). Must be at least 1. Must not
              be greater than 50.
            example: 10
        - in: query
          name: offset
          description: Pagination offset. Must be at least 0.
          example: 0
          required: false
          schema:
            type: integer
            description: Pagination offset. Must be at least 0.
            example: 0
        - in: query
          name: query
          description: Search within following name/username.
          example: john
          required: false
          schema:
            type: string
            description: Search within following name/username.
            example: john
            nullable: true
        - in: query
          name: filter
          description: ""
          example: []
          required: false
          schema:
            type: object
            description: ""
            example: []
            properties: {}
        - in: query
          name: filter.online
          description: Filter by online status (1 for online, 0 for offline, null for all).
          example: 1
          required: false
          schema:
            type: integer
            description: Filter by online status (1 for online, 0 for offline, null for
              all).
            example: 1
            enum:
              - 1
              - 0
            nullable: true
        - in: query
          name: filter.paid
          description: Filter by paid status (1 for paid, 0 for free, null for all).
          example: 1
          required: false
          schema:
            type: integer
            description: Filter by paid status (1 for paid, 0 for free, null for all).
            example: 1
            enum:
              - 1
              - 0
            nullable: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - view: x
                        avatar: https://public.onlyfans.com/files/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                        avatarThumbs:
                          c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                          c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                        header: https://public.onlyfans.com/files/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                        headerSize:
                          width: 4868
                          height: 851
                        headerThumbs:
                          w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                          w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                        id: 254
                        name: OnlyFans Creators
                        username: onlyfanscreators
                        canLookStory: true
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: true
                        canPayInternal: true
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: true
                        tipsTextEnabled: false
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: true
                        canAddSubscriber: false
                        subscribePrice: 0
                        isPaywallRequired: true
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: true
                        subscribedByExpire: false
                        subscribedByExpireDate: 2025-01-01T00:00:00+00:00
                        subscribedByAutoprolong: true
                        subscribedIsExpiredNow: false
                        currentSubscribePrice: 0
                        subscribedOn: false
                        subscribedOnExpiredNow: null
                        subscribedOnDuration: null
                        listsStates:
                          - id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                        canReport: false
                        canReceiveChatMessage: false
                        hideChat: false
                        lastSeen: null
                        isPerformer: true
                        isRealPerformer: true
                        subscribedByData:
                          price: 0
                          newPrice: 0
                          regularPrice: 0
                          subscribePrice: 0
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: 2025-01-01T00:00:00+00:00
                          expiredAt: 2025-01-01T00:00:00+00:00
                          renewedAt: 2025-01-01T00:00:00+00:00
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: null
                          isMuted: false
                          unsubscribeReason: No reason given
                          duration: 4 months
                          showPostsInFeed: true
                          subscribes:
                            - id: 123
                              userId: 254
                              subscriberId: 123
                              date: 2025-01-01T00:00:00+00:00
                              duration: 3652
                              startDate: 2025-01-01T00:00:00+00:00
                              expireDate: 2025-01-01T00:00:00+00:00
                              cancelDate: null
                              price: 0
                              regularPrice: 0
                              discount: 0
                              earningId: 0
                              action: subscribe
                              type: auto
                              offerStart: null
                              offerEnd: null
                              isCurrent: true
                          hasActivePaidSubscriptions: false
                        subscribedOnData: null
                        canTrialSend: false
                        isBlocked: false
                        canUnsubscribe: true
                        isPendingAutoprolong: false
                    hasMore: true
                  _pagination:
                    next_page: https://app.onlyfansapi.com/api/acct_abc123/following/expired?offset=10&limit=10
                  _meta:
                    _credits:
                      used: 1
                      balance: 999970
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49993
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - view: x
                            avatar: https://public.onlyfans.com/files/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                            avatarThumbs:
                              c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                              c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                            header: https://public.onlyfans.com/files/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                            headerSize:
                              width: 4868
                              height: 851
                            headerThumbs:
                              w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                              w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                            id: 254
                            name: OnlyFans Creators
                            username: onlyfanscreators
                            canLookStory: true
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: true
                            canPayInternal: true
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: true
                            tipsTextEnabled: false
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: true
                            canAddSubscriber: false
                            subscribePrice: 0
                            isPaywallRequired: true
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: true
                            subscribedByExpire: false
                            subscribedByExpireDate: 2025-01-01T00:00:00+00:00
                            subscribedByAutoprolong: true
                            subscribedIsExpiredNow: false
                            currentSubscribePrice: 0
                            subscribedOn: false
                            subscribedOnExpiredNow: null
                            subscribedOnDuration: null
                            listsStates:
                              - id: following
                                type: following
                                name: Following
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                            canReport: false
                            canReceiveChatMessage: false
                            hideChat: false
                            lastSeen: null
                            isPerformer: true
                            isRealPerformer: true
                            subscribedByData:
                              price: 0
                              newPrice: 0
                              regularPrice: 0
                              subscribePrice: 0
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: 2025-01-01T00:00:00+00:00
                              expiredAt: 2025-01-01T00:00:00+00:00
                              renewedAt: 2025-01-01T00:00:00+00:00
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: null
                              isMuted: false
                              unsubscribeReason: No reason given
                              duration: 4 months
                              showPostsInFeed: true
                              subscribes:
                                - id: 123
                                  userId: 254
                                  subscriberId: 123
                                  date: 2025-01-01T00:00:00+00:00
                                  duration: 3652
                                  startDate: 2025-01-01T00:00:00+00:00
                                  expireDate: 2025-01-01T00:00:00+00:00
                                  cancelDate: null
                                  price: 0
                                  regularPrice: 0
                                  discount: 0
                                  earningId: 0
                                  action: subscribe
                                  type: auto
                                  offerStart: null
                                  offerEnd: null
                                  isCurrent: true
                              hasActivePaidSubscriptions: false
                            subscribedOnData: null
                            canTrialSend: false
                            isBlocked: false
                            canUnsubscribe: true
                            isPendingAutoprolong: false
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: x
                            avatar:
                              type: string
                              example: https://public.onlyfans.com/files/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/c50/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                                c144:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/c144/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg
                            header:
                              type: string
                              example: https://public.onlyfans.com/files/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                            headerSize:
                              type: object
                              properties:
                                width:
                                  type: integer
                                  example: 4868
                                height:
                                  type: integer
                                  example: 851
                            headerThumbs:
                              type: object
                              properties:
                                w480:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/w480/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                                w760:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/w760/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg
                            id:
                              type: integer
                              example: 254
                            name:
                              type: string
                              example: OnlyFans Creators
                            username:
                              type: string
                              example: onlyfanscreators
                            canLookStory:
                              type: boolean
                              example: true
                            canCommentStory:
                              type: boolean
                              example: false
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: true
                            canPayInternal:
                              type: boolean
                              example: true
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: true
                            tipsTextEnabled:
                              type: boolean
                              example: false
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: true
                            canAddSubscriber:
                              type: boolean
                              example: false
                            subscribePrice:
                              type: integer
                              example: 0
                            isPaywallRequired:
                              type: boolean
                              example: true
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: true
                            subscribedByExpire:
                              type: boolean
                              example: false
                            subscribedByExpireDate:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            subscribedByAutoprolong:
                              type: boolean
                              example: true
                            subscribedIsExpiredNow:
                              type: boolean
                              example: false
                            currentSubscribePrice:
                              type: integer
                              example: 0
                            subscribedOn:
                              type: boolean
                              example: false
                            subscribedOnExpiredNow:
                              type: string
                              example: null
                              nullable: true
                            subscribedOnDuration:
                              type: string
                              example: null
                              nullable: true
                            listsStates:
                              type: array
                              example:
                                - id: following
                                  type: following
                                  name: Following
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: following
                                  type:
                                    type: string
                                    example: following
                                  name:
                                    type: string
                                    example: Following
                                  hasUser:
                                    type: boolean
                                    example: true
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: ALREADY_EXISTS
                            canReport:
                              type: boolean
                              example: false
                            canReceiveChatMessage:
                              type: boolean
                              example: false
                            hideChat:
                              type: boolean
                              example: false
                            lastSeen:
                              type: string
                              example: null
                              nullable: true
                            isPerformer:
                              type: boolean
                              example: true
                            isRealPerformer:
                              type: boolean
                              example: true
                            subscribedByData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: integer
                                  example: 0
                                subscribePrice:
                                  type: integer
                                  example: 0
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                expiredAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                renewedAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                discountFinishedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                discountStartedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                status:
                                  type: string
                                  example: null
                                  nullable: true
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: No reason given
                                duration:
                                  type: string
                                  example: 4 months
                                showPostsInFeed:
                                  type: boolean
                                  example: true
                                subscribes:
                                  type: array
                                  example:
                                    - id: 123
                                      userId: 254
                                      subscriberId: 123
                                      date: 2025-01-01T00:00:00+00:00
                                      duration: 3652
                                      startDate: 2025-01-01T00:00:00+00:00
                                      expireDate: 2025-01-01T00:00:00+00:00
                                      cancelDate: null
                                      price: 0
                                      regularPrice: 0
                                      discount: 0
                                      earningId: 0
                                      action: subscribe
                                      type: auto
                                      offerStart: null
                                      offerEnd: null
                                      isCurrent: true
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                        example: 123
                                      userId:
                                        type: integer
                                        example: 254
                                      subscriberId:
                                        type: integer
                                        example: 123
                                      date:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      duration:
                                        type: integer
                                        example: 3652
                                      startDate:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      expireDate:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      cancelDate:
                                        type: string
                                        example: null
                                        nullable: true
                                      price:
                                        type: integer
                                        example: 0
                                      regularPrice:
                                        type: integer
                                        example: 0
                                      discount:
                                        type: integer
                                        example: 0
                                      earningId:
                                        type: integer
                                        example: 0
                                      action:
                                        type: string
                                        example: subscribe
                                      type:
                                        type: string
                                        example: auto
                                      offerStart:
                                        type: string
                                        example: null
                                        nullable: true
                                      offerEnd:
                                        type: string
                                        example: null
                                        nullable: true
                                      isCurrent:
                                        type: boolean
                                        example: true
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            subscribedOnData:
                              type: string
                              example: null
                              nullable: true
                            canTrialSend:
                              type: boolean
                              example: false
                            isBlocked:
                              type: boolean
                              example: false
                            canUnsubscribe:
                              type: boolean
                              example: true
                            isPendingAutoprolong:
                              type: boolean
                              example: false
                      hasMore:
                        type: boolean
                        example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: https://app.onlyfansapi.com/api/acct_abc123/following/expired?offset=10&limit=10
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999970
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49993
      tags:
        - Following
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Clear Fan Notes (/api-reference/fans/clear-fan-notes)

Clear notes for a specific fan.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/fans/{fan_id}/notes
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/fans/{fan_id}/notes:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: fan_id
        description: Fan's OnlyFans ID
        example: 123
        required: true
        schema:
          type: string
    delete:
      summary: Clear Fan Notes
      operationId: clearFanNotes
      description: Clear notes for a specific fan.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    view: x
                    avatar: https://public.onlyfans.com/files/i/i2/i25/.../.../avatar.jpg
                    avatarThumbs:
                      c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../.../avatar.jpg
                      c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../.../avatar.jpg
                    header: https://public.onlyfans.com/files/c/cs/cse/.../.../header_image.jpg
                    headerSize:
                      width: 4386
                      height: 1224
                    headerThumbs:
                      w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../.../header_image.jpg
                      w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../.../header_image.jpg
                    id: 123
                    name: Name
                    username: username
                    canLookStory: true
                    canCommentStory: true
                    hasNotViewedStory: false
                    isVerified: true
                    canPayInternal: true
                    hasScheduledStream: false
                    hasStream: false
                    hasStories: false
                    tipsEnabled: true
                    tipsTextEnabled: true
                    tipsMin: 5
                    tipsMinInternal: 1
                    tipsMax: 200
                    canEarn: true
                    canAddSubscriber: true
                    subscribePrice: 12.99
                    subscriptionBundles:
                      - id: 123
                        discount: 50
                        duration: 3
                        price: 19.49
                        canBuy: true
                    displayName: ""
                    notice: foo
                    isPaywallRequired: true
                    isRestricted: false
                    canRestrict: true
                    subscribedBy: true
                    subscribedByExpire: false
                    subscribedByExpireDate: 2022-01-01T00:00:00+00:00
                    subscribedByAutoprolong: false
                    subscribedIsExpiredNow: false
                    currentSubscribePrice: 0
                    subscribedOn: null
                    subscribedOnExpiredNow: true
                    subscribedOnDuration: 7 days
                    listsStates:
                      - id: following
                        type: following
                        name: Following
                        hasUser: true
                        canAddUser: false
                        cannotAddUserReason: ALREADY_EXISTS
                      - id: fans
                        type: fans
                        name: Fans
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: null
                      - id: recent
                        type: recent
                        name: Recent (last 24 hours)
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: SYSTEM_LIST
                      - id: tagged
                        type: tagged
                        name: Tagged
                        hasUser: true
                        canAddUser: false
                        cannotAddUserReason: ALREADY_EXISTS
                      - id: friends
                        type: friends
                        name: Friends
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                      - id: muted
                        type: muted
                        name: Muted
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                    canReport: true
                    canReceiveChatMessage: true
                    hideChat: false
                    lastSeen: 2022-01-01T00:00:00+00:00
                    isPerformer: true
                    isRealPerformer: true
                    subscribedByData:
                      price: 0
                      newPrice: 0
                      regularPrice: 12.99
                      subscribePrice: 12.99
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: 2022-01-01T00:00:00+00:00
                      expiredAt: 2022-01-01T00:00:00+00:00
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: Set to Expire
                      isMuted: false
                      unsubscribeReason: No reason given
                      duration: 5 months
                      showPostsInFeed: true
                      subscribes:
                        - id: 123
                          userId: 123
                          subscriberId: 123
                          date: 2022-01-01T00:00:00+00:00
                          duration: 123
                          startDate: 2022-01-01T00:00:00+00:00
                          expireDate: 2022-01-01T00:00:00+00:00
                          cancelDate: null
                          price: 0
                          regularPrice: 12.99
                          discount: 0
                          earningId: 0
                          action: subscribe
                          type: trial
                          offerStart: 2022-01-01T00:00:00+00:00
                          offerEnd: null
                          isCurrent: true
                      hasActivePaidSubscriptions: false
                    subscribedOnData:
                      price: 0
                      newPrice: 0
                      regularPrice: 0
                      subscribePrice: 0
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: 2022-01-01T00:00:00+00:00
                      expiredAt: 2022-01-01T00:00:00+00:00
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: null
                      isMuted: false
                      unsubscribeReason: No reason given
                      duration: 7 days
                      tipsSumm: 0
                      subscribesSumm: 0
                      messagesSumm: 0
                      postsSumm: 0
                      streamsSumm: 0
                      totalSumm: 0
                      subscribes: []
                      hasActivePaidSubscriptions: false
                    canTrialSend: false
                    isBlocked: false
                    canUnsubscribe: true
                    isPendingAutoprolong: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999904
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49992
                properties:
                  data:
                    type: object
                    properties:
                      view:
                        type: string
                        example: x
                      avatar:
                        type: string
                        example: https://public.onlyfans.com/files/i/i2/i25/.../.../avatar.jpg
                      avatarThumbs:
                        type: object
                        properties:
                          c50:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../.../avatar.jpg
                          c144:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../.../avatar.jpg
                      header:
                        type: string
                        example: https://public.onlyfans.com/files/c/cs/cse/.../.../header_image.jpg
                      headerSize:
                        type: object
                        properties:
                          width:
                            type: integer
                            example: 4386
                          height:
                            type: integer
                            example: 1224
                      headerThumbs:
                        type: object
                        properties:
                          w480:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../.../header_image.jpg
                          w760:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../.../header_image.jpg
                      id:
                        type: integer
                        example: 123
                      name:
                        type: string
                        example: Name
                      username:
                        type: string
                        example: username
                      canLookStory:
                        type: boolean
                        example: true
                      canCommentStory:
                        type: boolean
                        example: true
                      hasNotViewedStory:
                        type: boolean
                        example: false
                      isVerified:
                        type: boolean
                        example: true
                      canPayInternal:
                        type: boolean
                        example: true
                      hasScheduledStream:
                        type: boolean
                        example: false
                      hasStream:
                        type: boolean
                        example: false
                      hasStories:
                        type: boolean
                        example: false
                      tipsEnabled:
                        type: boolean
                        example: true
                      tipsTextEnabled:
                        type: boolean
                        example: true
                      tipsMin:
                        type: integer
                        example: 5
                      tipsMinInternal:
                        type: integer
                        example: 1
                      tipsMax:
                        type: integer
                        example: 200
                      canEarn:
                        type: boolean
                        example: true
                      canAddSubscriber:
                        type: boolean
                        example: true
                      subscribePrice:
                        type: number
                        example: 12.99
                      subscriptionBundles:
                        type: array
                        example:
                          - id: 123
                            discount: 50
                            duration: 3
                            price: 19.49
                            canBuy: true
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            discount:
                              type: integer
                              example: 50
                            duration:
                              type: integer
                              example: 3
                            price:
                              type: number
                              example: 19.49
                            canBuy:
                              type: boolean
                              example: true
                      displayName:
                        type: string
                        example: ""
                      notice:
                        type: string
                        example: foo
                      isPaywallRequired:
                        type: boolean
                        example: true
                      isRestricted:
                        type: boolean
                        example: false
                      canRestrict:
                        type: boolean
                        example: true
                      subscribedBy:
                        type: boolean
                        example: true
                      subscribedByExpire:
                        type: boolean
                        example: false
                      subscribedByExpireDate:
                        type: string
                        example: 2022-01-01T00:00:00+00:00
                      subscribedByAutoprolong:
                        type: boolean
                        example: false
                      subscribedIsExpiredNow:
                        type: boolean
                        example: false
                      currentSubscribePrice:
                        type: integer
                        example: 0
                      subscribedOn:
                        type: string
                        example: null
                        nullable: true
                      subscribedOnExpiredNow:
                        type: boolean
                        example: true
                      subscribedOnDuration:
                        type: string
                        example: 7 days
                      listsStates:
                        type: array
                        example:
                          - id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: fans
                            type: fans
                            name: Fans
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          - id: recent
                            type: recent
                            name: Recent (last 24 hours)
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          - id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: following
                            type:
                              type: string
                              example: following
                            name:
                              type: string
                              example: Following
                            hasUser:
                              type: boolean
                              example: true
                            canAddUser:
                              type: boolean
                              example: false
                            cannotAddUserReason:
                              type: string
                              example: ALREADY_EXISTS
                      canReport:
                        type: boolean
                        example: true
                      canReceiveChatMessage:
                        type: boolean
                        example: true
                      hideChat:
                        type: boolean
                        example: false
                      lastSeen:
                        type: string
                        example: 2022-01-01T00:00:00+00:00
                      isPerformer:
                        type: boolean
                        example: true
                      isRealPerformer:
                        type: boolean
                        example: true
                      subscribedByData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: number
                            example: 12.99
                          subscribePrice:
                            type: number
                            example: 12.99
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: 2022-01-01T00:00:00+00:00
                          expiredAt:
                            type: string
                            example: 2022-01-01T00:00:00+00:00
                          renewedAt:
                            type: string
                            example: null
                            nullable: true
                          discountFinishedAt:
                            type: string
                            example: null
                            nullable: true
                          discountStartedAt:
                            type: string
                            example: null
                            nullable: true
                          status:
                            type: string
                            example: Set to Expire
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: No reason given
                          duration:
                            type: string
                            example: 5 months
                          showPostsInFeed:
                            type: boolean
                            example: true
                          subscribes:
                            type: array
                            example:
                              - id: 123
                                userId: 123
                                subscriberId: 123
                                date: 2022-01-01T00:00:00+00:00
                                duration: 123
                                startDate: 2022-01-01T00:00:00+00:00
                                expireDate: 2022-01-01T00:00:00+00:00
                                cancelDate: null
                                price: 0
                                regularPrice: 12.99
                                discount: 0
                                earningId: 0
                                action: subscribe
                                type: trial
                                offerStart: 2022-01-01T00:00:00+00:00
                                offerEnd: null
                                isCurrent: true
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                userId:
                                  type: integer
                                  example: 123
                                subscriberId:
                                  type: integer
                                  example: 123
                                date:
                                  type: string
                                  example: 2022-01-01T00:00:00+00:00
                                duration:
                                  type: integer
                                  example: 123
                                startDate:
                                  type: string
                                  example: 2022-01-01T00:00:00+00:00
                                expireDate:
                                  type: string
                                  example: 2022-01-01T00:00:00+00:00
                                cancelDate:
                                  type: string
                                  example: null
                                  nullable: true
                                price:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: number
                                  example: 12.99
                                discount:
                                  type: integer
                                  example: 0
                                earningId:
                                  type: integer
                                  example: 0
                                action:
                                  type: string
                                  example: subscribe
                                type:
                                  type: string
                                  example: trial
                                offerStart:
                                  type: string
                                  example: 2022-01-01T00:00:00+00:00
                                offerEnd:
                                  type: string
                                  example: null
                                  nullable: true
                                isCurrent:
                                  type: boolean
                                  example: true
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      subscribedOnData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: integer
                            example: 0
                          subscribePrice:
                            type: integer
                            example: 0
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: 2022-01-01T00:00:00+00:00
                          expiredAt:
                            type: string
                            example: 2022-01-01T00:00:00+00:00
                          renewedAt:
                            type: string
                            example: null
                            nullable: true
                          discountFinishedAt:
                            type: string
                            example: null
                            nullable: true
                          discountStartedAt:
                            type: string
                            example: null
                            nullable: true
                          status:
                            type: string
                            example: null
                            nullable: true
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: No reason given
                          duration:
                            type: string
                            example: 7 days
                          tipsSumm:
                            type: integer
                            example: 0
                          subscribesSumm:
                            type: integer
                            example: 0
                          messagesSumm:
                            type: integer
                            example: 0
                          postsSumm:
                            type: integer
                            example: 0
                          streamsSumm:
                            type: integer
                            example: 0
                          totalSumm:
                            type: integer
                            example: 0
                          subscribes:
                            type: array
                            example: []
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      canTrialSend:
                        type: boolean
                        example: false
                      isBlocked:
                        type: boolean
                        example: false
                      canUnsubscribe:
                        type: boolean
                        example: true
                      isPendingAutoprolong:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999904
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49992
      tags:
        - Fans
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Create/Edit Fan Notes (/api-reference/fans/create-edit-fan-notes)

Create or edit notes for a specific fan.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml put /api/{account}/fans/{fan_id}/notes
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/fans/{fan_id}/notes:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: fan_id
        description: Fan's OnlyFans ID
        example: 123
        required: true
        schema:
          type: string
    put:
      summary: Create/Edit Fan Notes
      operationId: createEditFanNotes
      description: Create or edit notes for a specific fan.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    view: x
                    avatar: https://public.onlyfans.com/files/i/i2/i25/.../.../avatar.jpg
                    avatarThumbs:
                      c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../.../avatar.jpg
                      c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../.../avatar.jpg
                    header: https://public.onlyfans.com/files/c/cs/cse/.../.../header_image.jpg
                    headerSize:
                      width: 4386
                      height: 1224
                    headerThumbs:
                      w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../.../header_image.jpg
                      w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../.../header_image.jpg
                    id: 123
                    name: Name
                    username: username
                    canLookStory: true
                    canCommentStory: true
                    hasNotViewedStory: false
                    isVerified: true
                    canPayInternal: true
                    hasScheduledStream: false
                    hasStream: false
                    hasStories: false
                    tipsEnabled: true
                    tipsTextEnabled: true
                    tipsMin: 5
                    tipsMinInternal: 1
                    tipsMax: 200
                    canEarn: true
                    canAddSubscriber: true
                    subscribePrice: 12.99
                    subscriptionBundles:
                      - id: 123
                        discount: 50
                        duration: 3
                        price: 19.49
                        canBuy: true
                    displayName: ""
                    notice: foo
                    isPaywallRequired: true
                    isRestricted: false
                    canRestrict: true
                    subscribedBy: true
                    subscribedByExpire: false
                    subscribedByExpireDate: 2022-01-01T00:00:00+00:00
                    subscribedByAutoprolong: false
                    subscribedIsExpiredNow: false
                    currentSubscribePrice: 0
                    subscribedOn: null
                    subscribedOnExpiredNow: true
                    subscribedOnDuration: 7 days
                    listsStates:
                      - id: following
                        type: following
                        name: Following
                        hasUser: true
                        canAddUser: false
                        cannotAddUserReason: ALREADY_EXISTS
                      - id: fans
                        type: fans
                        name: Fans
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: null
                      - id: recent
                        type: recent
                        name: Recent (last 24 hours)
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: SYSTEM_LIST
                      - id: tagged
                        type: tagged
                        name: Tagged
                        hasUser: true
                        canAddUser: false
                        cannotAddUserReason: ALREADY_EXISTS
                      - id: friends
                        type: friends
                        name: Friends
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                      - id: muted
                        type: muted
                        name: Muted
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                    canReport: true
                    canReceiveChatMessage: true
                    hideChat: false
                    lastSeen: 2022-01-01T00:00:00+00:00
                    isPerformer: true
                    isRealPerformer: true
                    subscribedByData:
                      price: 0
                      newPrice: 0
                      regularPrice: 12.99
                      subscribePrice: 12.99
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: 2022-01-01T00:00:00+00:00
                      expiredAt: 2022-01-01T00:00:00+00:00
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: Set to Expire
                      isMuted: false
                      unsubscribeReason: No reason given
                      duration: 5 months
                      showPostsInFeed: true
                      subscribes:
                        - id: 123
                          userId: 123
                          subscriberId: 123
                          date: 2022-01-01T00:00:00+00:00
                          duration: 123
                          startDate: 2022-01-01T00:00:00+00:00
                          expireDate: 2022-01-01T00:00:00+00:00
                          cancelDate: null
                          price: 0
                          regularPrice: 12.99
                          discount: 0
                          earningId: 0
                          action: subscribe
                          type: trial
                          offerStart: 2022-01-01T00:00:00+00:00
                          offerEnd: null
                          isCurrent: true
                      hasActivePaidSubscriptions: false
                    subscribedOnData:
                      price: 0
                      newPrice: 0
                      regularPrice: 0
                      subscribePrice: 0
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: 2022-01-01T00:00:00+00:00
                      expiredAt: 2022-01-01T00:00:00+00:00
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: null
                      isMuted: false
                      unsubscribeReason: No reason given
                      duration: 7 days
                      tipsSumm: 0
                      subscribesSumm: 0
                      messagesSumm: 0
                      postsSumm: 0
                      streamsSumm: 0
                      totalSumm: 0
                      subscribes: []
                      hasActivePaidSubscriptions: false
                    canTrialSend: false
                    isBlocked: false
                    canUnsubscribe: true
                    isPendingAutoprolong: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999904
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49992
                properties:
                  data:
                    type: object
                    properties:
                      view:
                        type: string
                        example: x
                      avatar:
                        type: string
                        example: https://public.onlyfans.com/files/i/i2/i25/.../.../avatar.jpg
                      avatarThumbs:
                        type: object
                        properties:
                          c50:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../.../avatar.jpg
                          c144:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../.../avatar.jpg
                      header:
                        type: string
                        example: https://public.onlyfans.com/files/c/cs/cse/.../.../header_image.jpg
                      headerSize:
                        type: object
                        properties:
                          width:
                            type: integer
                            example: 4386
                          height:
                            type: integer
                            example: 1224
                      headerThumbs:
                        type: object
                        properties:
                          w480:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../.../header_image.jpg
                          w760:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../.../header_image.jpg
                      id:
                        type: integer
                        example: 123
                      name:
                        type: string
                        example: Name
                      username:
                        type: string
                        example: username
                      canLookStory:
                        type: boolean
                        example: true
                      canCommentStory:
                        type: boolean
                        example: true
                      hasNotViewedStory:
                        type: boolean
                        example: false
                      isVerified:
                        type: boolean
                        example: true
                      canPayInternal:
                        type: boolean
                        example: true
                      hasScheduledStream:
                        type: boolean
                        example: false
                      hasStream:
                        type: boolean
                        example: false
                      hasStories:
                        type: boolean
                        example: false
                      tipsEnabled:
                        type: boolean
                        example: true
                      tipsTextEnabled:
                        type: boolean
                        example: true
                      tipsMin:
                        type: integer
                        example: 5
                      tipsMinInternal:
                        type: integer
                        example: 1
                      tipsMax:
                        type: integer
                        example: 200
                      canEarn:
                        type: boolean
                        example: true
                      canAddSubscriber:
                        type: boolean
                        example: true
                      subscribePrice:
                        type: number
                        example: 12.99
                      subscriptionBundles:
                        type: array
                        example:
                          - id: 123
                            discount: 50
                            duration: 3
                            price: 19.49
                            canBuy: true
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            discount:
                              type: integer
                              example: 50
                            duration:
                              type: integer
                              example: 3
                            price:
                              type: number
                              example: 19.49
                            canBuy:
                              type: boolean
                              example: true
                      displayName:
                        type: string
                        example: ""
                      notice:
                        type: string
                        example: foo
                      isPaywallRequired:
                        type: boolean
                        example: true
                      isRestricted:
                        type: boolean
                        example: false
                      canRestrict:
                        type: boolean
                        example: true
                      subscribedBy:
                        type: boolean
                        example: true
                      subscribedByExpire:
                        type: boolean
                        example: false
                      subscribedByExpireDate:
                        type: string
                        example: 2022-01-01T00:00:00+00:00
                      subscribedByAutoprolong:
                        type: boolean
                        example: false
                      subscribedIsExpiredNow:
                        type: boolean
                        example: false
                      currentSubscribePrice:
                        type: integer
                        example: 0
                      subscribedOn:
                        type: string
                        example: null
                        nullable: true
                      subscribedOnExpiredNow:
                        type: boolean
                        example: true
                      subscribedOnDuration:
                        type: string
                        example: 7 days
                      listsStates:
                        type: array
                        example:
                          - id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: fans
                            type: fans
                            name: Fans
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          - id: recent
                            type: recent
                            name: Recent (last 24 hours)
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          - id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: following
                            type:
                              type: string
                              example: following
                            name:
                              type: string
                              example: Following
                            hasUser:
                              type: boolean
                              example: true
                            canAddUser:
                              type: boolean
                              example: false
                            cannotAddUserReason:
                              type: string
                              example: ALREADY_EXISTS
                      canReport:
                        type: boolean
                        example: true
                      canReceiveChatMessage:
                        type: boolean
                        example: true
                      hideChat:
                        type: boolean
                        example: false
                      lastSeen:
                        type: string
                        example: 2022-01-01T00:00:00+00:00
                      isPerformer:
                        type: boolean
                        example: true
                      isRealPerformer:
                        type: boolean
                        example: true
                      subscribedByData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: number
                            example: 12.99
                          subscribePrice:
                            type: number
                            example: 12.99
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: 2022-01-01T00:00:00+00:00
                          expiredAt:
                            type: string
                            example: 2022-01-01T00:00:00+00:00
                          renewedAt:
                            type: string
                            example: null
                            nullable: true
                          discountFinishedAt:
                            type: string
                            example: null
                            nullable: true
                          discountStartedAt:
                            type: string
                            example: null
                            nullable: true
                          status:
                            type: string
                            example: Set to Expire
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: No reason given
                          duration:
                            type: string
                            example: 5 months
                          showPostsInFeed:
                            type: boolean
                            example: true
                          subscribes:
                            type: array
                            example:
                              - id: 123
                                userId: 123
                                subscriberId: 123
                                date: 2022-01-01T00:00:00+00:00
                                duration: 123
                                startDate: 2022-01-01T00:00:00+00:00
                                expireDate: 2022-01-01T00:00:00+00:00
                                cancelDate: null
                                price: 0
                                regularPrice: 12.99
                                discount: 0
                                earningId: 0
                                action: subscribe
                                type: trial
                                offerStart: 2022-01-01T00:00:00+00:00
                                offerEnd: null
                                isCurrent: true
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                userId:
                                  type: integer
                                  example: 123
                                subscriberId:
                                  type: integer
                                  example: 123
                                date:
                                  type: string
                                  example: 2022-01-01T00:00:00+00:00
                                duration:
                                  type: integer
                                  example: 123
                                startDate:
                                  type: string
                                  example: 2022-01-01T00:00:00+00:00
                                expireDate:
                                  type: string
                                  example: 2022-01-01T00:00:00+00:00
                                cancelDate:
                                  type: string
                                  example: null
                                  nullable: true
                                price:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: number
                                  example: 12.99
                                discount:
                                  type: integer
                                  example: 0
                                earningId:
                                  type: integer
                                  example: 0
                                action:
                                  type: string
                                  example: subscribe
                                type:
                                  type: string
                                  example: trial
                                offerStart:
                                  type: string
                                  example: 2022-01-01T00:00:00+00:00
                                offerEnd:
                                  type: string
                                  example: null
                                  nullable: true
                                isCurrent:
                                  type: boolean
                                  example: true
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      subscribedOnData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: integer
                            example: 0
                          subscribePrice:
                            type: integer
                            example: 0
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: 2022-01-01T00:00:00+00:00
                          expiredAt:
                            type: string
                            example: 2022-01-01T00:00:00+00:00
                          renewedAt:
                            type: string
                            example: null
                            nullable: true
                          discountFinishedAt:
                            type: string
                            example: null
                            nullable: true
                          discountStartedAt:
                            type: string
                            example: null
                            nullable: true
                          status:
                            type: string
                            example: null
                            nullable: true
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: No reason given
                          duration:
                            type: string
                            example: 7 days
                          tipsSumm:
                            type: integer
                            example: 0
                          subscribesSumm:
                            type: integer
                            example: 0
                          messagesSumm:
                            type: integer
                            example: 0
                          postsSumm:
                            type: integer
                            example: 0
                          streamsSumm:
                            type: integer
                            example: 0
                          totalSumm:
                            type: integer
                            example: 0
                          subscribes:
                            type: array
                            example: []
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      canTrialSend:
                        type: boolean
                        example: false
                      isBlocked:
                        type: boolean
                        example: false
                      canUnsubscribe:
                        type: boolean
                        example: true
                      isPendingAutoprolong:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999904
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49992
      tags:
        - Fans
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                notes:
                  type: string
                  description: The new note value.
                  example: Example note
              required:
                - notes
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Fan Notes (/api-reference/fans/get-fan-notes)

Retrieve notes for a specific fan.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/fans/{fan_id}/notes
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/fans/{fan_id}/notes:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: fan_id
        description: Fan's OnlyFans ID
        example: 123
        required: true
        schema:
          type: string
    get:
      summary: Get Fan Notes
      operationId: getFanNotes
      description: Retrieve notes for a specific fan.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    notes: Example note
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999897
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49985
                properties:
                  data:
                    type: object
                    properties:
                      notes:
                        type: string
                        example: Example note
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999897
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49985
      tags:
        - Fans
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Subscription History (/api-reference/fans/get-subscription-history)

Get Subscription History for a given OnlyFans User ID. This can be useful, for example, when the user's subscribed to your account for the first time.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/fans/{user_id}/subscriptions-history
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/fans/{user_id}/subscriptions-history:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: user_id
        description: The OnlyFans ID of the User.
        example: 123
        required: true
        schema:
          type: string
    get:
      summary: Get Subscription History
      operationId: getSubscriptionHistory
      description: Get Subscription History for a given OnlyFans User ID. This can be
        useful, for example, when the user's subscribed to your account for the
        first time.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - subscribeDate: 2022-06-18T19:39:16+00:00
                        expireDate: 2022-07-18T19:39:16+00:00
                        price: 12.99
                      - subscribeDate: 2022-08-15T02:59:40+00:00
                        expireDate: 2022-09-15T02:59:40+00:00
                        price: 11.04
                      - subscribeDate: 2022-09-25T15:21:27+00:00
                        expireDate: 2022-10-25T15:21:27+00:00
                        price: 12.99
                      - subscribeDate: 2023-01-07T15:53:09+00:00
                        expireDate: 2023-02-07T15:53:09+00:00
                        price: 12.99
                      - subscribeDate: 2023-03-03T16:10:44+00:00
                        expireDate: 2023-04-03T16:10:44+00:00
                        price: 12.99
                      - subscribeDate: 2023-05-07T19:38:24+00:00
                        expireDate: 2023-06-07T19:38:24+00:00
                        price: 12.99
                      - subscribeDate: 2023-10-16T15:43:16+00:00
                        expireDate: 2023-11-16T15:43:16+00:00
                        price: 12.99
                      - subscribeDate: 2024-01-27T11:52:03+00:00
                        expireDate: 2024-02-27T11:52:03+00:00
                        price: 12.99
                      - subscribeDate: 2024-06-30T15:27:07+00:00
                        expireDate: 2024-07-30T15:27:07+00:00
                        price: 12.99
                      - subscribeDate: 2024-09-27T03:20:34+00:00
                        expireDate: 2024-10-27T03:20:34+00:00
                        price: 12.99
                      - subscribeDate: 2024-12-18T19:57:33+00:00
                        expireDate: 2025-01-18T19:57:33+00:00
                        price: 3.25
                      - subscribeDate: 2025-05-13T02:26:27+00:00
                        expireDate: 2025-06-13T02:26:27+00:00
                        price: 3.25
                      - subscribeDate: 2025-06-20T02:35:27+00:00
                        expireDate: 2025-07-20T02:35:27+00:00
                        price: 12.99
                      - subscribeDate: 2025-08-04T14:56:23+00:00
                        expireDate: 2025-09-04T14:56:23+00:00
                        price: 3.25
                      - subscribeDate: 2025-10-11T05:45:51+00:00
                        expireDate: 2025-10-18T05:45:51+00:00
                        price: 0
                      - subscribeDate: 2025-11-07T21:55:21+00:00
                        expireDate: 2025-12-07T21:55:21+00:00
                        price: 12.99
                    hasMore: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 224348
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: null
                      remaining_minute: 998
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - subscribeDate: 2022-06-18T19:39:16+00:00
                            expireDate: 2022-07-18T19:39:16+00:00
                            price: 12.99
                          - subscribeDate: 2022-08-15T02:59:40+00:00
                            expireDate: 2022-09-15T02:59:40+00:00
                            price: 11.04
                          - subscribeDate: 2022-09-25T15:21:27+00:00
                            expireDate: 2022-10-25T15:21:27+00:00
                            price: 12.99
                          - subscribeDate: 2023-01-07T15:53:09+00:00
                            expireDate: 2023-02-07T15:53:09+00:00
                            price: 12.99
                          - subscribeDate: 2023-03-03T16:10:44+00:00
                            expireDate: 2023-04-03T16:10:44+00:00
                            price: 12.99
                          - subscribeDate: 2023-05-07T19:38:24+00:00
                            expireDate: 2023-06-07T19:38:24+00:00
                            price: 12.99
                          - subscribeDate: 2023-10-16T15:43:16+00:00
                            expireDate: 2023-11-16T15:43:16+00:00
                            price: 12.99
                          - subscribeDate: 2024-01-27T11:52:03+00:00
                            expireDate: 2024-02-27T11:52:03+00:00
                            price: 12.99
                          - subscribeDate: 2024-06-30T15:27:07+00:00
                            expireDate: 2024-07-30T15:27:07+00:00
                            price: 12.99
                          - subscribeDate: 2024-09-27T03:20:34+00:00
                            expireDate: 2024-10-27T03:20:34+00:00
                            price: 12.99
                          - subscribeDate: 2024-12-18T19:57:33+00:00
                            expireDate: 2025-01-18T19:57:33+00:00
                            price: 3.25
                          - subscribeDate: 2025-05-13T02:26:27+00:00
                            expireDate: 2025-06-13T02:26:27+00:00
                            price: 3.25
                          - subscribeDate: 2025-06-20T02:35:27+00:00
                            expireDate: 2025-07-20T02:35:27+00:00
                            price: 12.99
                          - subscribeDate: 2025-08-04T14:56:23+00:00
                            expireDate: 2025-09-04T14:56:23+00:00
                            price: 3.25
                          - subscribeDate: 2025-10-11T05:45:51+00:00
                            expireDate: 2025-10-18T05:45:51+00:00
                            price: 0
                          - subscribeDate: 2025-11-07T21:55:21+00:00
                            expireDate: 2025-12-07T21:55:21+00:00
                            price: 12.99
                        items:
                          type: object
                          properties:
                            subscribeDate:
                              type: string
                              example: 2022-06-18T19:39:16+00:00
                            expireDate:
                              type: string
                              example: 2022-07-18T19:39:16+00:00
                            price:
                              type: number
                              example: 12.99
                      hasMore:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 224348
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Fans
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Active Fans (/api-reference/fans/list-active-fans)

Get a paginated list of fans for an Account. Newest fans are first.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/fans/active
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/fans/active:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Active Fans
      operationId: listActiveFans
      description: Get a paginated list of fans for an Account. Newest fans are first.
      parameters:
        - in: query
          name: limit
          description: Number of fans to return (1-50). Must be at least 1. Must not be
            greater than 20.
          example: 20
          required: false
          schema:
            type: integer
            description: Number of fans to return (1-50). Must be at least 1. Must not be
              greater than 20.
            example: 20
        - in: query
          name: offset
          description: Number of fans to skip. Must be at least 0.
          example: 0
          required: false
          schema:
            type: integer
            description: Number of fans to skip. Must be at least 0.
            example: 0
        - in: query
          name: type
          description: Filter by fan type.
          example: null
          required: false
          schema:
            type: string
            description: Filter by fan type.
            example: null
            enum:
              - active
              - expired
              - all
        - in: query
          name: filter
          description: ""
          example: []
          required: false
          schema:
            type: object
            description: ""
            example: []
            properties: {}
        - in: query
          name: filter.online
          description: Filter by online status (`1` for online fans).
          example: null
          required: false
          schema:
            type: integer
            description: Filter by online status (`1` for online fans).
            example: null
            enum:
              - 1
              - 0
            nullable: true
        - in: query
          name: filter.total_spent
          description: Filter by minimum amount total spent by a fan. Must be at least 0.
          example: null
          required: false
          schema:
            type: integer
            description: Filter by minimum amount total spent by a fan. Must be at least 0.
            example: null
        - in: query
          name: filter.tips
          description: Filter by minimum tips. Must be at least 0.
          example: null
          required: false
          schema:
            type: integer
            description: Filter by minimum tips. Must be at least 0.
            example: null
        - in: query
          name: filter.duration
          description: Filter by minimum subscription duration in months. Must be at least
            0.
          example: null
          required: false
          schema:
            type: integer
            description: Filter by minimum subscription duration in months. Must be at least
              0.
            example: null
        - in: query
          name: query
          description: Search within fan name/username.
          example: null
          required: false
          schema:
            type: string
            description: Search within fan name/username.
            example: null
            nullable: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - view: x
                        avatar: https://public.onlyfans.com/files/l/la/lal/.../123/avatar.jpg
                        avatarThumbs:
                          c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/l/la/lal/.../123/avatar.jpg
                          c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/l/la/lal/.../123/avatar.jpg
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 123
                        name: name
                        username: username
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: true
                        canPayInternal: true
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: true
                        canAddSubscriber: true
                        subscribePrice: 4.99
                        subscriptionBundles: []
                        displayName: ""
                        notice: ""
                        isPaywallRequired: true
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: 6 days
                        listsStates:
                          - id: following
                            type: following
                            name: Following
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: fans
                            type: fans
                            name: Fans
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: recent
                            type: recent
                            name: Recent (last 24 hours)
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          - id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                        canReport: false
                        canReceiveChatMessage: true
                        hideChat: false
                        lastSeen: 2025-01-01T00:00:00+00:00
                        isPerformer: true
                        isRealPerformer: true
                        subscribedByData: null
                        subscribedOnData:
                          price: 0
                          newPrice: 0
                          regularPrice: 0
                          subscribePrice: 0
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: 2025-01-01T00:00:00+00:00
                          expiredAt: 2025-01-01T00:00:00+00:00
                          renewedAt: null
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: Set to Expire
                          isMuted: false
                          unsubscribeReason: No reason given
                          duration: 6 days
                          tipsSumm: 0
                          subscribesSumm: 0
                          messagesSumm: 0
                          postsSumm: 0
                          streamsSumm: 0
                          totalSumm: 0
                          lastActivity: 2025-01-01T00:00:00+00:00
                          recommendations: 0
                          subscribes:
                            - id: 123
                              userId: 123
                              subscriberId: 123
                              date: 2025-01-01T00:00:00+00:00
                              duration: 7
                              startDate: 2025-01-01T00:00:00+00:00
                              expireDate: 2025-01-01T00:00:00+00:00
                              cancelDate: null
                              price: 0
                              regularPrice: 4.99
                              discount: 0
                              earningId: 0
                              action: subscribe
                              type: trial
                              offerStart: 2025-01-01T00:00:00+00:00
                              offerEnd: 2025-01-01T00:00:00+00:00
                              isCurrent: true
                          hasActivePaidSubscriptions: false
                        canTrialSend: false
                        isBlocked: false
                        promoOffers:
                          - id: 123
                            subscribeDays: 7
                            createdAt: 2025-01-01T00:00:00+00:00
                            expiredAt: 2025-01-01T00:00:00+00:00
                            finishedAt: 2025-01-01T00:00:00+00:00
                            subscriberId: "123"
                            userId: "123"
                    hasMore: false
                  _pagination:
                    next_page: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999840
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49998
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - view: x
                            avatar: https://public.onlyfans.com/files/l/la/lal/.../123/avatar.jpg
                            avatarThumbs:
                              c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/l/la/lal/.../123/avatar.jpg
                              c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/l/la/lal/.../123/avatar.jpg
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 123
                            name: name
                            username: username
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: true
                            canPayInternal: true
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: true
                            canAddSubscriber: true
                            subscribePrice: 4.99
                            subscriptionBundles: []
                            displayName: ""
                            notice: ""
                            isPaywallRequired: true
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: 6 days
                            listsStates:
                              - id: following
                                type: following
                                name: Following
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              - id: fans
                                type: fans
                                name: Fans
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              - id: recent
                                type: recent
                                name: Recent (last 24 hours)
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              - id: tagged
                                type: tagged
                                name: Tagged
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              - id: friends
                                type: friends
                                name: Friends
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                              - id: muted
                                type: muted
                                name: Muted
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                            canReport: false
                            canReceiveChatMessage: true
                            hideChat: false
                            lastSeen: 2025-01-01T00:00:00+00:00
                            isPerformer: true
                            isRealPerformer: true
                            subscribedByData: null
                            subscribedOnData:
                              price: 0
                              newPrice: 0
                              regularPrice: 0
                              subscribePrice: 0
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: 2025-01-01T00:00:00+00:00
                              expiredAt: 2025-01-01T00:00:00+00:00
                              renewedAt: null
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: Set to Expire
                              isMuted: false
                              unsubscribeReason: No reason given
                              duration: 6 days
                              tipsSumm: 0
                              subscribesSumm: 0
                              messagesSumm: 0
                              postsSumm: 0
                              streamsSumm: 0
                              totalSumm: 0
                              lastActivity: 2025-01-01T00:00:00+00:00
                              recommendations: 0
                              subscribes:
                                - id: 123
                                  userId: 123
                                  subscriberId: 123
                                  date: 2025-01-01T00:00:00+00:00
                                  duration: 7
                                  startDate: 2025-01-01T00:00:00+00:00
                                  expireDate: 2025-01-01T00:00:00+00:00
                                  cancelDate: null
                                  price: 0
                                  regularPrice: 4.99
                                  discount: 0
                                  earningId: 0
                                  action: subscribe
                                  type: trial
                                  offerStart: 2025-01-01T00:00:00+00:00
                                  offerEnd: 2025-01-01T00:00:00+00:00
                                  isCurrent: true
                              hasActivePaidSubscriptions: false
                            canTrialSend: false
                            isBlocked: false
                            promoOffers:
                              - id: 123
                                subscribeDays: 7
                                createdAt: 2025-01-01T00:00:00+00:00
                                expiredAt: 2025-01-01T00:00:00+00:00
                                finishedAt: 2025-01-01T00:00:00+00:00
                                subscriberId: "123"
                                userId: "123"
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: x
                            avatar:
                              type: string
                              example: https://public.onlyfans.com/files/l/la/lal/.../123/avatar.jpg
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/c50/l/la/lal/.../123/avatar.jpg
                                c144:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/c144/l/la/lal/.../123/avatar.jpg
                            header:
                              type: string
                              example: null
                              nullable: true
                            headerSize:
                              type: string
                              example: null
                              nullable: true
                            headerThumbs:
                              type: string
                              example: null
                              nullable: true
                            id:
                              type: integer
                              example: 123
                            name:
                              type: string
                              example: name
                            username:
                              type: string
                              example: username
                            canLookStory:
                              type: boolean
                              example: false
                            canCommentStory:
                              type: boolean
                              example: false
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: true
                            canPayInternal:
                              type: boolean
                              example: true
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: false
                            tipsTextEnabled:
                              type: boolean
                              example: true
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: true
                            canAddSubscriber:
                              type: boolean
                              example: true
                            subscribePrice:
                              type: number
                              example: 4.99
                            subscriptionBundles:
                              type: array
                              example: []
                            displayName:
                              type: string
                              example: ""
                            notice:
                              type: string
                              example: ""
                            isPaywallRequired:
                              type: boolean
                              example: true
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: false
                            subscribedByExpire:
                              type: string
                              example: null
                              nullable: true
                            subscribedByExpireDate:
                              type: string
                              example: null
                              nullable: true
                            subscribedByAutoprolong:
                              type: string
                              example: null
                              nullable: true
                            subscribedIsExpiredNow:
                              type: string
                              example: null
                              nullable: true
                            currentSubscribePrice:
                              type: string
                              example: null
                              nullable: true
                            subscribedOn:
                              type: boolean
                              example: true
                            subscribedOnExpiredNow:
                              type: boolean
                              example: false
                            subscribedOnDuration:
                              type: string
                              example: 6 days
                            listsStates:
                              type: array
                              example:
                                - id: following
                                  type: following
                                  name: Following
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                - id: fans
                                  type: fans
                                  name: Fans
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                - id: recent
                                  type: recent
                                  name: Recent (last 24 hours)
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                - id: tagged
                                  type: tagged
                                  name: Tagged
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                - id: friends
                                  type: friends
                                  name: Friends
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                                - id: muted
                                  type: muted
                                  name: Muted
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: following
                                  type:
                                    type: string
                                    example: following
                                  name:
                                    type: string
                                    example: Following
                                  hasUser:
                                    type: boolean
                                    example: false
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: SYSTEM_LIST
                            canReport:
                              type: boolean
                              example: false
                            canReceiveChatMessage:
                              type: boolean
                              example: true
                            hideChat:
                              type: boolean
                              example: false
                            lastSeen:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            isPerformer:
                              type: boolean
                              example: true
                            isRealPerformer:
                              type: boolean
                              example: true
                            subscribedByData:
                              type: string
                              example: null
                              nullable: true
                            subscribedOnData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: integer
                                  example: 0
                                subscribePrice:
                                  type: integer
                                  example: 0
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                expiredAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                renewedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                discountFinishedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                discountStartedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                status:
                                  type: string
                                  example: Set to Expire
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: No reason given
                                duration:
                                  type: string
                                  example: 6 days
                                tipsSumm:
                                  type: integer
                                  example: 0
                                subscribesSumm:
                                  type: integer
                                  example: 0
                                messagesSumm:
                                  type: integer
                                  example: 0
                                postsSumm:
                                  type: integer
                                  example: 0
                                streamsSumm:
                                  type: integer
                                  example: 0
                                totalSumm:
                                  type: integer
                                  example: 0
                                lastActivity:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                recommendations:
                                  type: integer
                                  example: 0
                                subscribes:
                                  type: array
                                  example:
                                    - id: 123
                                      userId: 123
                                      subscriberId: 123
                                      date: 2025-01-01T00:00:00+00:00
                                      duration: 7
                                      startDate: 2025-01-01T00:00:00+00:00
                                      expireDate: 2025-01-01T00:00:00+00:00
                                      cancelDate: null
                                      price: 0
                                      regularPrice: 4.99
                                      discount: 0
                                      earningId: 0
                                      action: subscribe
                                      type: trial
                                      offerStart: 2025-01-01T00:00:00+00:00
                                      offerEnd: 2025-01-01T00:00:00+00:00
                                      isCurrent: true
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                        example: 123
                                      userId:
                                        type: integer
                                        example: 123
                                      subscriberId:
                                        type: integer
                                        example: 123
                                      date:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      duration:
                                        type: integer
                                        example: 7
                                      startDate:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      expireDate:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      cancelDate:
                                        type: string
                                        example: null
                                        nullable: true
                                      price:
                                        type: integer
                                        example: 0
                                      regularPrice:
                                        type: number
                                        example: 4.99
                                      discount:
                                        type: integer
                                        example: 0
                                      earningId:
                                        type: integer
                                        example: 0
                                      action:
                                        type: string
                                        example: subscribe
                                      type:
                                        type: string
                                        example: trial
                                      offerStart:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      offerEnd:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      isCurrent:
                                        type: boolean
                                        example: true
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            canTrialSend:
                              type: boolean
                              example: false
                            isBlocked:
                              type: boolean
                              example: false
                            promoOffers:
                              type: array
                              example:
                                - id: 123
                                  subscribeDays: 7
                                  createdAt: 2025-01-01T00:00:00+00:00
                                  expiredAt: 2025-01-01T00:00:00+00:00
                                  finishedAt: 2025-01-01T00:00:00+00:00
                                  subscriberId: "123"
                                  userId: "123"
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  subscribeDays:
                                    type: integer
                                    example: 7
                                  createdAt:
                                    type: string
                                    example: 2025-01-01T00:00:00+00:00
                                  expiredAt:
                                    type: string
                                    example: 2025-01-01T00:00:00+00:00
                                  finishedAt:
                                    type: string
                                    example: 2025-01-01T00:00:00+00:00
                                  subscriberId:
                                    type: string
                                    example: "123"
                                  userId:
                                    type: string
                                    example: "123"
                      hasMore:
                        type: boolean
                        example: false
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: null
                        nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999840
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49998
      tags:
        - Fans
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List All Fans (/api-reference/fans/list-all-fans)

Get a paginated list of fans for an Account. Newest fans are first.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/fans/all
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/fans/all:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List All Fans
      operationId: listAllFans
      description: Get a paginated list of fans for an Account. Newest fans are first.
      parameters:
        - in: query
          name: limit
          description: Number of fans to return (1-50). Must be at least 1. Must not be
            greater than 20.
          example: 20
          required: false
          schema:
            type: integer
            description: Number of fans to return (1-50). Must be at least 1. Must not be
              greater than 20.
            example: 20
        - in: query
          name: offset
          description: Number of fans to skip. Must be at least 0.
          example: 0
          required: false
          schema:
            type: integer
            description: Number of fans to skip. Must be at least 0.
            example: 0
        - in: query
          name: type
          description: Filter by fan type.
          example: null
          required: false
          schema:
            type: string
            description: Filter by fan type.
            example: null
            enum:
              - active
              - expired
              - all
        - in: query
          name: filter
          description: ""
          example: []
          required: false
          schema:
            type: object
            description: ""
            example: []
            properties: {}
        - in: query
          name: filter.online
          description: Filter by online status (`1` for online fans).
          example: null
          required: false
          schema:
            type: integer
            description: Filter by online status (`1` for online fans).
            example: null
            enum:
              - 1
              - 0
            nullable: true
        - in: query
          name: filter.total_spent
          description: Filter by minimum amount total spent by a fan. Must be at least 0.
          example: null
          required: false
          schema:
            type: integer
            description: Filter by minimum amount total spent by a fan. Must be at least 0.
            example: null
        - in: query
          name: filter.tips
          description: Filter by minimum tips. Must be at least 0.
          example: null
          required: false
          schema:
            type: integer
            description: Filter by minimum tips. Must be at least 0.
            example: null
        - in: query
          name: filter.duration
          description: Filter by minimum subscription duration in months. Must be at least
            0.
          example: null
          required: false
          schema:
            type: integer
            description: Filter by minimum subscription duration in months. Must be at least
              0.
            example: null
        - in: query
          name: query
          description: Search within fan name/username.
          example: null
          required: false
          schema:
            type: string
            description: Search within fan name/username.
            example: null
            nullable: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - view: x
                        avatar: https://public.onlyfans.com/files/l/la/lal/.../123/avatar.jpg
                        avatarThumbs:
                          c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/l/la/lal/.../123/avatar.jpg
                          c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/l/la/lal/.../123/avatar.jpg
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 123
                        name: name
                        username: username
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: true
                        canPayInternal: true
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: true
                        canAddSubscriber: true
                        subscribePrice: 4.99
                        subscriptionBundles: []
                        displayName: ""
                        notice: ""
                        isPaywallRequired: true
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: 6 days
                        listsStates:
                          - id: following
                            type: following
                            name: Following
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: fans
                            type: fans
                            name: Fans
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: recent
                            type: recent
                            name: Recent (last 24 hours)
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          - id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                        canReport: false
                        canReceiveChatMessage: true
                        hideChat: false
                        lastSeen: 2025-01-01T00:00:00+00:00
                        isPerformer: true
                        isRealPerformer: true
                        subscribedByData: null
                        subscribedOnData:
                          price: 0
                          newPrice: 0
                          regularPrice: 0
                          subscribePrice: 0
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: 2025-01-01T00:00:00+00:00
                          expiredAt: 2025-01-01T00:00:00+00:00
                          renewedAt: null
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: Set to Expire
                          isMuted: false
                          unsubscribeReason: No reason given
                          duration: 6 days
                          tipsSumm: 0
                          subscribesSumm: 0
                          messagesSumm: 0
                          postsSumm: 0
                          streamsSumm: 0
                          totalSumm: 0
                          lastActivity: 2025-01-01T00:00:00+00:00
                          recommendations: 0
                          subscribes:
                            - id: 213
                              userId: 123
                              subscriberId: 123
                              date: 2025-01-01T00:00:00+00:00
                              duration: 7
                              startDate: 2025-01-01T00:00:00+00:00
                              expireDate: 2025-01-01T00:00:00+00:00
                              cancelDate: null
                              price: 0
                              regularPrice: 4.99
                              discount: 0
                              earningId: 0
                              action: subscribe
                              type: trial
                              offerStart: 2025-01-01T00:00:00+00:00
                              offerEnd: 2025-01-01T00:00:00+00:00
                              isCurrent: true
                          hasActivePaidSubscriptions: false
                        canTrialSend: false
                        isBlocked: false
                        promoOffers:
                          - id: 123
                            subscribeDays: 7
                            createdAt: 2025-01-01T00:00:00+00:00
                            expiredAt: 2025-01-01T00:00:00+00:00
                            finishedAt: 2025-01-01T00:00:00+00:00
                            subscriberId: "123"
                            userId: "123"
                    hasMore: true
                  _pagination:
                    next_page: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999839
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49997
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - view: x
                            avatar: https://public.onlyfans.com/files/l/la/lal/.../123/avatar.jpg
                            avatarThumbs:
                              c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/l/la/lal/.../123/avatar.jpg
                              c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/l/la/lal/.../123/avatar.jpg
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 123
                            name: name
                            username: username
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: true
                            canPayInternal: true
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: true
                            canAddSubscriber: true
                            subscribePrice: 4.99
                            subscriptionBundles: []
                            displayName: ""
                            notice: ""
                            isPaywallRequired: true
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: 6 days
                            listsStates:
                              - id: following
                                type: following
                                name: Following
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              - id: fans
                                type: fans
                                name: Fans
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              - id: recent
                                type: recent
                                name: Recent (last 24 hours)
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              - id: tagged
                                type: tagged
                                name: Tagged
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              - id: friends
                                type: friends
                                name: Friends
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                              - id: muted
                                type: muted
                                name: Muted
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                            canReport: false
                            canReceiveChatMessage: true
                            hideChat: false
                            lastSeen: 2025-01-01T00:00:00+00:00
                            isPerformer: true
                            isRealPerformer: true
                            subscribedByData: null
                            subscribedOnData:
                              price: 0
                              newPrice: 0
                              regularPrice: 0
                              subscribePrice: 0
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: 2025-01-01T00:00:00+00:00
                              expiredAt: 2025-01-01T00:00:00+00:00
                              renewedAt: null
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: Set to Expire
                              isMuted: false
                              unsubscribeReason: No reason given
                              duration: 6 days
                              tipsSumm: 0
                              subscribesSumm: 0
                              messagesSumm: 0
                              postsSumm: 0
                              streamsSumm: 0
                              totalSumm: 0
                              lastActivity: 2025-01-01T00:00:00+00:00
                              recommendations: 0
                              subscribes:
                                - id: 213
                                  userId: 123
                                  subscriberId: 123
                                  date: 2025-01-01T00:00:00+00:00
                                  duration: 7
                                  startDate: 2025-01-01T00:00:00+00:00
                                  expireDate: 2025-01-01T00:00:00+00:00
                                  cancelDate: null
                                  price: 0
                                  regularPrice: 4.99
                                  discount: 0
                                  earningId: 0
                                  action: subscribe
                                  type: trial
                                  offerStart: 2025-01-01T00:00:00+00:00
                                  offerEnd: 2025-01-01T00:00:00+00:00
                                  isCurrent: true
                              hasActivePaidSubscriptions: false
                            canTrialSend: false
                            isBlocked: false
                            promoOffers:
                              - id: 123
                                subscribeDays: 7
                                createdAt: 2025-01-01T00:00:00+00:00
                                expiredAt: 2025-01-01T00:00:00+00:00
                                finishedAt: 2025-01-01T00:00:00+00:00
                                subscriberId: "123"
                                userId: "123"
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: x
                            avatar:
                              type: string
                              example: https://public.onlyfans.com/files/l/la/lal/.../123/avatar.jpg
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/c50/l/la/lal/.../123/avatar.jpg
                                c144:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/c144/l/la/lal/.../123/avatar.jpg
                            header:
                              type: string
                              example: null
                              nullable: true
                            headerSize:
                              type: string
                              example: null
                              nullable: true
                            headerThumbs:
                              type: string
                              example: null
                              nullable: true
                            id:
                              type: integer
                              example: 123
                            name:
                              type: string
                              example: name
                            username:
                              type: string
                              example: username
                            canLookStory:
                              type: boolean
                              example: false
                            canCommentStory:
                              type: boolean
                              example: false
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: true
                            canPayInternal:
                              type: boolean
                              example: true
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: false
                            tipsTextEnabled:
                              type: boolean
                              example: true
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: true
                            canAddSubscriber:
                              type: boolean
                              example: true
                            subscribePrice:
                              type: number
                              example: 4.99
                            subscriptionBundles:
                              type: array
                              example: []
                            displayName:
                              type: string
                              example: ""
                            notice:
                              type: string
                              example: ""
                            isPaywallRequired:
                              type: boolean
                              example: true
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: false
                            subscribedByExpire:
                              type: string
                              example: null
                              nullable: true
                            subscribedByExpireDate:
                              type: string
                              example: null
                              nullable: true
                            subscribedByAutoprolong:
                              type: string
                              example: null
                              nullable: true
                            subscribedIsExpiredNow:
                              type: string
                              example: null
                              nullable: true
                            currentSubscribePrice:
                              type: string
                              example: null
                              nullable: true
                            subscribedOn:
                              type: boolean
                              example: true
                            subscribedOnExpiredNow:
                              type: boolean
                              example: false
                            subscribedOnDuration:
                              type: string
                              example: 6 days
                            listsStates:
                              type: array
                              example:
                                - id: following
                                  type: following
                                  name: Following
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                - id: fans
                                  type: fans
                                  name: Fans
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                - id: recent
                                  type: recent
                                  name: Recent (last 24 hours)
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                - id: tagged
                                  type: tagged
                                  name: Tagged
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                - id: friends
                                  type: friends
                                  name: Friends
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                                - id: muted
                                  type: muted
                                  name: Muted
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: following
                                  type:
                                    type: string
                                    example: following
                                  name:
                                    type: string
                                    example: Following
                                  hasUser:
                                    type: boolean
                                    example: false
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: SYSTEM_LIST
                            canReport:
                              type: boolean
                              example: false
                            canReceiveChatMessage:
                              type: boolean
                              example: true
                            hideChat:
                              type: boolean
                              example: false
                            lastSeen:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            isPerformer:
                              type: boolean
                              example: true
                            isRealPerformer:
                              type: boolean
                              example: true
                            subscribedByData:
                              type: string
                              example: null
                              nullable: true
                            subscribedOnData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: integer
                                  example: 0
                                subscribePrice:
                                  type: integer
                                  example: 0
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                expiredAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                renewedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                discountFinishedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                discountStartedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                status:
                                  type: string
                                  example: Set to Expire
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: No reason given
                                duration:
                                  type: string
                                  example: 6 days
                                tipsSumm:
                                  type: integer
                                  example: 0
                                subscribesSumm:
                                  type: integer
                                  example: 0
                                messagesSumm:
                                  type: integer
                                  example: 0
                                postsSumm:
                                  type: integer
                                  example: 0
                                streamsSumm:
                                  type: integer
                                  example: 0
                                totalSumm:
                                  type: integer
                                  example: 0
                                lastActivity:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                recommendations:
                                  type: integer
                                  example: 0
                                subscribes:
                                  type: array
                                  example:
                                    - id: 213
                                      userId: 123
                                      subscriberId: 123
                                      date: 2025-01-01T00:00:00+00:00
                                      duration: 7
                                      startDate: 2025-01-01T00:00:00+00:00
                                      expireDate: 2025-01-01T00:00:00+00:00
                                      cancelDate: null
                                      price: 0
                                      regularPrice: 4.99
                                      discount: 0
                                      earningId: 0
                                      action: subscribe
                                      type: trial
                                      offerStart: 2025-01-01T00:00:00+00:00
                                      offerEnd: 2025-01-01T00:00:00+00:00
                                      isCurrent: true
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                        example: 213
                                      userId:
                                        type: integer
                                        example: 123
                                      subscriberId:
                                        type: integer
                                        example: 123
                                      date:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      duration:
                                        type: integer
                                        example: 7
                                      startDate:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      expireDate:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      cancelDate:
                                        type: string
                                        example: null
                                        nullable: true
                                      price:
                                        type: integer
                                        example: 0
                                      regularPrice:
                                        type: number
                                        example: 4.99
                                      discount:
                                        type: integer
                                        example: 0
                                      earningId:
                                        type: integer
                                        example: 0
                                      action:
                                        type: string
                                        example: subscribe
                                      type:
                                        type: string
                                        example: trial
                                      offerStart:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      offerEnd:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      isCurrent:
                                        type: boolean
                                        example: true
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            canTrialSend:
                              type: boolean
                              example: false
                            isBlocked:
                              type: boolean
                              example: false
                            promoOffers:
                              type: array
                              example:
                                - id: 123
                                  subscribeDays: 7
                                  createdAt: 2025-01-01T00:00:00+00:00
                                  expiredAt: 2025-01-01T00:00:00+00:00
                                  finishedAt: 2025-01-01T00:00:00+00:00
                                  subscriberId: "123"
                                  userId: "123"
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  subscribeDays:
                                    type: integer
                                    example: 7
                                  createdAt:
                                    type: string
                                    example: 2025-01-01T00:00:00+00:00
                                  expiredAt:
                                    type: string
                                    example: 2025-01-01T00:00:00+00:00
                                  finishedAt:
                                    type: string
                                    example: 2025-01-01T00:00:00+00:00
                                  subscriberId:
                                    type: string
                                    example: "123"
                                  userId:
                                    type: string
                                    example: "123"
                      hasMore:
                        type: boolean
                        example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: null
                        nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999839
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49997
      tags:
        - Fans
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Expired Fans (/api-reference/fans/list-expired-fans)

Get a paginated list of expired fans for an Account. Newest fans are first.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/fans/expired
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/fans/expired:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Expired Fans
      operationId: listExpiredFans
      description: Get a paginated list of expired fans for an Account. Newest fans
        are first.
      parameters:
        - in: query
          name: limit
          description: Number of fans to return (1-50). Must be at least 1. Must not be
            greater than 20.
          example: 20
          required: false
          schema:
            type: integer
            description: Number of fans to return (1-50). Must be at least 1. Must not be
              greater than 20.
            example: 20
        - in: query
          name: offset
          description: Number of fans to skip. Must be at least 0.
          example: 0
          required: false
          schema:
            type: integer
            description: Number of fans to skip. Must be at least 0.
            example: 0
        - in: query
          name: type
          description: Filter by fan type.
          example: null
          required: false
          schema:
            type: string
            description: Filter by fan type.
            example: null
            enum:
              - active
              - expired
              - all
        - in: query
          name: filter
          description: ""
          example: []
          required: false
          schema:
            type: object
            description: ""
            example: []
            properties: {}
        - in: query
          name: filter.online
          description: Filter by online status (`1` for online fans).
          example: null
          required: false
          schema:
            type: integer
            description: Filter by online status (`1` for online fans).
            example: null
            enum:
              - 1
              - 0
            nullable: true
        - in: query
          name: filter.total_spent
          description: Filter by minimum amount total spent by a fan. Must be at least 0.
          example: null
          required: false
          schema:
            type: integer
            description: Filter by minimum amount total spent by a fan. Must be at least 0.
            example: null
        - in: query
          name: filter.tips
          description: Filter by minimum tips. Must be at least 0.
          example: null
          required: false
          schema:
            type: integer
            description: Filter by minimum tips. Must be at least 0.
            example: null
        - in: query
          name: filter.duration
          description: Filter by minimum subscription duration in months. Must be at least
            0.
          example: null
          required: false
          schema:
            type: integer
            description: Filter by minimum subscription duration in months. Must be at least
              0.
            example: null
        - in: query
          name: query
          description: Search within fan name/username.
          example: null
          required: false
          schema:
            type: string
            description: Search within fan name/username.
            example: null
            nullable: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - view: x
                        avatar: https://public.onlyfans.com/files/i/i2/i25/.../123/avatar.jpg
                        avatarThumbs:
                          c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../123/avatar.jpg
                          c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../123/avatar.jpg
                        header: https://public.onlyfans.com/files/c/cs/cse/.../123/header_image.jpg
                        headerSize:
                          width: 4386
                          height: 1224
                        headerThumbs:
                          w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../123/header_image.jpg
                          w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../123/header_image.jpg
                        id: 123
                        name: name
                        username: username
                        canLookStory: true
                        canCommentStory: true
                        hasNotViewedStory: true
                        isVerified: true
                        canPayInternal: true
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: true
                        tipsEnabled: true
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: true
                        canAddSubscriber: true
                        subscribePrice: 12.99
                        subscriptionBundles:
                          - id: 123
                            discount: 50
                            duration: 3
                            price: 19.49
                            canBuy: true
                        displayName: ""
                        notice: ""
                        isPaywallRequired: true
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: true
                        subscribedByExpire: false
                        subscribedByExpireDate: 2025-01-01T00:00:00+00:00
                        subscribedByAutoprolong: false
                        subscribedIsExpiredNow: false
                        currentSubscribePrice: 0
                        subscribedOn: null
                        subscribedOnExpiredNow: true
                        subscribedOnDuration: 7 days
                        listsStates:
                          - id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: fans
                            type: fans
                            name: Fans
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          - id: recent
                            type: recent
                            name: Recent (last 24 hours)
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          - id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                        canReport: true
                        canReceiveChatMessage: true
                        hideChat: false
                        lastSeen: 2025-01-01T00:00:00+00:00
                        isPerformer: true
                        isRealPerformer: true
                        subscribedByData:
                          price: 0
                          newPrice: 0
                          regularPrice: 12.99
                          subscribePrice: 12.99
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: 2025-01-01T00:00:00+00:00
                          expiredAt: 2025-01-01T00:00:00+00:00
                          renewedAt: null
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: Set to Expire
                          isMuted: false
                          unsubscribeReason: No reason given
                          duration: 2 months
                          showPostsInFeed: true
                          subscribes:
                            - id: 123
                              userId: 123
                              subscriberId: 123
                              date: 2025-01-01T00:00:00+00:00
                              duration: 360
                              startDate: 2025-01-01T00:00:00+00:00
                              expireDate: 2025-01-01T00:00:00+00:00
                              cancelDate: null
                              price: 0
                              regularPrice: 12.99
                              discount: 0
                              earningId: 0
                              action: subscribe
                              type: trial
                              offerStart: 2025-01-01T00:00:00+00:00
                              offerEnd: null
                              isCurrent: true
                          hasActivePaidSubscriptions: false
                        subscribedOnData:
                          price: 0
                          newPrice: 0
                          regularPrice: 0
                          subscribePrice: 0
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: 2025-01-01T00:00:00+00:00
                          expiredAt: 2025-01-01T00:00:00+00:00
                          renewedAt: null
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: null
                          isMuted: false
                          unsubscribeReason: No reason given
                          duration: 7 days
                          tipsSumm: 0
                          subscribesSumm: 0
                          messagesSumm: 0
                          postsSumm: 0
                          streamsSumm: 0
                          totalSumm: 0
                          lastActivity: 2025-01-01T00:00:00+00:00
                          recommendations: 0
                          subscribes: []
                          hasActivePaidSubscriptions: false
                        canTrialSend: false
                        isBlocked: false
                        promoOffers: []
                        canUnsubscribe: true
                        isPendingAutoprolong: false
                    hasMore: true
                  _pagination:
                    next_page: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999838
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49996
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - view: x
                            avatar: https://public.onlyfans.com/files/i/i2/i25/.../123/avatar.jpg
                            avatarThumbs:
                              c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../123/avatar.jpg
                              c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../123/avatar.jpg
                            header: https://public.onlyfans.com/files/c/cs/cse/.../123/header_image.jpg
                            headerSize:
                              width: 4386
                              height: 1224
                            headerThumbs:
                              w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../123/header_image.jpg
                              w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../123/header_image.jpg
                            id: 123
                            name: name
                            username: username
                            canLookStory: true
                            canCommentStory: true
                            hasNotViewedStory: true
                            isVerified: true
                            canPayInternal: true
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: true
                            tipsEnabled: true
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: true
                            canAddSubscriber: true
                            subscribePrice: 12.99
                            subscriptionBundles:
                              - id: 123
                                discount: 50
                                duration: 3
                                price: 19.49
                                canBuy: true
                            displayName: ""
                            notice: ""
                            isPaywallRequired: true
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: true
                            subscribedByExpire: false
                            subscribedByExpireDate: 2025-01-01T00:00:00+00:00
                            subscribedByAutoprolong: false
                            subscribedIsExpiredNow: false
                            currentSubscribePrice: 0
                            subscribedOn: null
                            subscribedOnExpiredNow: true
                            subscribedOnDuration: 7 days
                            listsStates:
                              - id: following
                                type: following
                                name: Following
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              - id: fans
                                type: fans
                                name: Fans
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: null
                              - id: recent
                                type: recent
                                name: Recent (last 24 hours)
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              - id: tagged
                                type: tagged
                                name: Tagged
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              - id: friends
                                type: friends
                                name: Friends
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                              - id: muted
                                type: muted
                                name: Muted
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                            canReport: true
                            canReceiveChatMessage: true
                            hideChat: false
                            lastSeen: 2025-01-01T00:00:00+00:00
                            isPerformer: true
                            isRealPerformer: true
                            subscribedByData:
                              price: 0
                              newPrice: 0
                              regularPrice: 12.99
                              subscribePrice: 12.99
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: 2025-01-01T00:00:00+00:00
                              expiredAt: 2025-01-01T00:00:00+00:00
                              renewedAt: null
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: Set to Expire
                              isMuted: false
                              unsubscribeReason: No reason given
                              duration: 2 months
                              showPostsInFeed: true
                              subscribes:
                                - id: 123
                                  userId: 123
                                  subscriberId: 123
                                  date: 2025-01-01T00:00:00+00:00
                                  duration: 360
                                  startDate: 2025-01-01T00:00:00+00:00
                                  expireDate: 2025-01-01T00:00:00+00:00
                                  cancelDate: null
                                  price: 0
                                  regularPrice: 12.99
                                  discount: 0
                                  earningId: 0
                                  action: subscribe
                                  type: trial
                                  offerStart: 2025-01-01T00:00:00+00:00
                                  offerEnd: null
                                  isCurrent: true
                              hasActivePaidSubscriptions: false
                            subscribedOnData:
                              price: 0
                              newPrice: 0
                              regularPrice: 0
                              subscribePrice: 0
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: 2025-01-01T00:00:00+00:00
                              expiredAt: 2025-01-01T00:00:00+00:00
                              renewedAt: null
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: null
                              isMuted: false
                              unsubscribeReason: No reason given
                              duration: 7 days
                              tipsSumm: 0
                              subscribesSumm: 0
                              messagesSumm: 0
                              postsSumm: 0
                              streamsSumm: 0
                              totalSumm: 0
                              lastActivity: 2025-01-01T00:00:00+00:00
                              recommendations: 0
                              subscribes: []
                              hasActivePaidSubscriptions: false
                            canTrialSend: false
                            isBlocked: false
                            promoOffers: []
                            canUnsubscribe: true
                            isPendingAutoprolong: false
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: x
                            avatar:
                              type: string
                              example: https://public.onlyfans.com/files/i/i2/i25/.../123/avatar.jpg
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../123/avatar.jpg
                                c144:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../123/avatar.jpg
                            header:
                              type: string
                              example: https://public.onlyfans.com/files/c/cs/cse/.../123/header_image.jpg
                            headerSize:
                              type: object
                              properties:
                                width:
                                  type: integer
                                  example: 4386
                                height:
                                  type: integer
                                  example: 1224
                            headerThumbs:
                              type: object
                              properties:
                                w480:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../123/header_image.jpg
                                w760:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../123/header_image.jpg
                            id:
                              type: integer
                              example: 123
                            name:
                              type: string
                              example: name
                            username:
                              type: string
                              example: username
                            canLookStory:
                              type: boolean
                              example: true
                            canCommentStory:
                              type: boolean
                              example: true
                            hasNotViewedStory:
                              type: boolean
                              example: true
                            isVerified:
                              type: boolean
                              example: true
                            canPayInternal:
                              type: boolean
                              example: true
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: true
                            tipsEnabled:
                              type: boolean
                              example: true
                            tipsTextEnabled:
                              type: boolean
                              example: true
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: true
                            canAddSubscriber:
                              type: boolean
                              example: true
                            subscribePrice:
                              type: number
                              example: 12.99
                            subscriptionBundles:
                              type: array
                              example:
                                - id: 123
                                  discount: 50
                                  duration: 3
                                  price: 19.49
                                  canBuy: true
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  discount:
                                    type: integer
                                    example: 50
                                  duration:
                                    type: integer
                                    example: 3
                                  price:
                                    type: number
                                    example: 19.49
                                  canBuy:
                                    type: boolean
                                    example: true
                            displayName:
                              type: string
                              example: ""
                            notice:
                              type: string
                              example: ""
                            isPaywallRequired:
                              type: boolean
                              example: true
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: true
                            subscribedByExpire:
                              type: boolean
                              example: false
                            subscribedByExpireDate:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            subscribedByAutoprolong:
                              type: boolean
                              example: false
                            subscribedIsExpiredNow:
                              type: boolean
                              example: false
                            currentSubscribePrice:
                              type: integer
                              example: 0
                            subscribedOn:
                              type: string
                              example: null
                              nullable: true
                            subscribedOnExpiredNow:
                              type: boolean
                              example: true
                            subscribedOnDuration:
                              type: string
                              example: 7 days
                            listsStates:
                              type: array
                              example:
                                - id: following
                                  type: following
                                  name: Following
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                - id: fans
                                  type: fans
                                  name: Fans
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: null
                                - id: recent
                                  type: recent
                                  name: Recent (last 24 hours)
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                - id: tagged
                                  type: tagged
                                  name: Tagged
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                - id: friends
                                  type: friends
                                  name: Friends
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                                - id: muted
                                  type: muted
                                  name: Muted
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: following
                                  type:
                                    type: string
                                    example: following
                                  name:
                                    type: string
                                    example: Following
                                  hasUser:
                                    type: boolean
                                    example: true
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: ALREADY_EXISTS
                            canReport:
                              type: boolean
                              example: true
                            canReceiveChatMessage:
                              type: boolean
                              example: true
                            hideChat:
                              type: boolean
                              example: false
                            lastSeen:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            isPerformer:
                              type: boolean
                              example: true
                            isRealPerformer:
                              type: boolean
                              example: true
                            subscribedByData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: number
                                  example: 12.99
                                subscribePrice:
                                  type: number
                                  example: 12.99
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                expiredAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                renewedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                discountFinishedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                discountStartedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                status:
                                  type: string
                                  example: Set to Expire
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: No reason given
                                duration:
                                  type: string
                                  example: 2 months
                                showPostsInFeed:
                                  type: boolean
                                  example: true
                                subscribes:
                                  type: array
                                  example:
                                    - id: 123
                                      userId: 123
                                      subscriberId: 123
                                      date: 2025-01-01T00:00:00+00:00
                                      duration: 360
                                      startDate: 2025-01-01T00:00:00+00:00
                                      expireDate: 2025-01-01T00:00:00+00:00
                                      cancelDate: null
                                      price: 0
                                      regularPrice: 12.99
                                      discount: 0
                                      earningId: 0
                                      action: subscribe
                                      type: trial
                                      offerStart: 2025-01-01T00:00:00+00:00
                                      offerEnd: null
                                      isCurrent: true
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                        example: 123
                                      userId:
                                        type: integer
                                        example: 123
                                      subscriberId:
                                        type: integer
                                        example: 123
                                      date:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      duration:
                                        type: integer
                                        example: 360
                                      startDate:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      expireDate:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      cancelDate:
                                        type: string
                                        example: null
                                        nullable: true
                                      price:
                                        type: integer
                                        example: 0
                                      regularPrice:
                                        type: number
                                        example: 12.99
                                      discount:
                                        type: integer
                                        example: 0
                                      earningId:
                                        type: integer
                                        example: 0
                                      action:
                                        type: string
                                        example: subscribe
                                      type:
                                        type: string
                                        example: trial
                                      offerStart:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      offerEnd:
                                        type: string
                                        example: null
                                        nullable: true
                                      isCurrent:
                                        type: boolean
                                        example: true
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            subscribedOnData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: integer
                                  example: 0
                                subscribePrice:
                                  type: integer
                                  example: 0
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                expiredAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                renewedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                discountFinishedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                discountStartedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                status:
                                  type: string
                                  example: null
                                  nullable: true
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: No reason given
                                duration:
                                  type: string
                                  example: 7 days
                                tipsSumm:
                                  type: integer
                                  example: 0
                                subscribesSumm:
                                  type: integer
                                  example: 0
                                messagesSumm:
                                  type: integer
                                  example: 0
                                postsSumm:
                                  type: integer
                                  example: 0
                                streamsSumm:
                                  type: integer
                                  example: 0
                                totalSumm:
                                  type: integer
                                  example: 0
                                lastActivity:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                recommendations:
                                  type: integer
                                  example: 0
                                subscribes:
                                  type: array
                                  example: []
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            canTrialSend:
                              type: boolean
                              example: false
                            isBlocked:
                              type: boolean
                              example: false
                            promoOffers:
                              type: array
                              example: []
                            canUnsubscribe:
                              type: boolean
                              example: true
                            isPendingAutoprolong:
                              type: boolean
                              example: false
                      hasMore:
                        type: boolean
                        example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: null
                        nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999838
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49996
      tags:
        - Fans
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Latest Fans (/api-reference/fans/list-latest-fans)

Get a paginated list fans, filterable by total, only new subscribers, or only renewals. Newest fans are first.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/fans/latest
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/fans/latest:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Latest Fans
      operationId: listLatestFans
      description: Get a paginated list fans, filterable by total, only new
        subscribers, or only renewals. Newest fans are first.
      parameters:
        - in: query
          name: start_date
          description: Start date for filtering (required with end_date). Must be a valid
            date. Must not be greater than 255 characters.
          example: 2024-01-01
          required: false
          schema:
            type: string
            description: Start date for filtering (required with end_date). Must be a valid
              date. Must not be greater than 255 characters.
            example: 2024-01-01
            nullable: true
        - in: query
          name: end_date
          description: End date for filtering (required with start_date). Must be a valid
            date. Must not be greater than 255 characters.
          example: 2024-12-31
          required: false
          schema:
            type: string
            description: End date for filtering (required with start_date). Must be a valid
              date. Must not be greater than 255 characters.
            example: 2024-12-31
            nullable: true
        - in: query
          name: type
          description: "Filter by type: total, renew, or new."
          example: total
          required: false
          schema:
            type: string
            description: "Filter by type: total, renew, or new."
            example: total
            enum:
              - total
              - renew
              - new
            nullable: true
        - in: query
          name: offset
          description: Number of fans to skip. Must be at least 0.
          example: 0
          required: false
          schema:
            type: integer
            description: Number of fans to skip. Must be at least 0.
            example: 0
        - in: query
          name: limit
          description: Number of fans to return (1-50). Must be at least 1. Must not be
            greater than 100.
          example: 50
          required: false
          schema:
            type: integer
            description: Number of fans to return (1-50). Must be at least 1. Must not be
              greater than 100.
            example: 50
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    users:
                      - view: x
                        avatar: https://public.onlyfans.com/files/l/la/lal/.../123/avatar.jpg
                        avatarThumbs:
                          c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/l/la/lal/.../123/avatar.jpg
                          c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/l/la/lal/.../123/avatar.jpg
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 123
                        name: name
                        username: username
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: true
                        canPayInternal: true
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: true
                        canAddSubscriber: true
                        subscribePrice: 4.99
                        subscriptionBundles: []
                        displayName: ""
                        notice: ""
                        isPaywallRequired: true
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: 6 days
                        listsStates:
                          - id: following
                            type: following
                            name: Following
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: fans
                            type: fans
                            name: Fans
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: recent
                            type: recent
                            name: Recent (last 24 hours)
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          - id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                        canReport: false
                        canReceiveChatMessage: true
                        hideChat: false
                        lastSeen: 2025-01-01T00:00:00+00:00
                        isPerformer: true
                        isRealPerformer: true
                        subscribedByData: null
                        subscribedOnData:
                          price: 0
                          newPrice: 0
                          regularPrice: 0
                          subscribePrice: 0
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: 2025-01-01T00:00:00+00:00
                          expiredAt: 2025-01-01T00:00:00+00:00
                          renewedAt: null
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: Set to Expire
                          isMuted: false
                          unsubscribeReason: No reason given
                          duration: 6 days
                          tipsSumm: 0
                          subscribesSumm: 0
                          messagesSumm: 0
                          postsSumm: 0
                          streamsSumm: 0
                          totalSumm: 0
                          lastActivity: 2025-01-01T00:00:00+00:00
                          recommendations: 0
                          subscribes:
                            - id: 123
                              userId: 123
                              subscriberId: 123
                              date: 2025-01-01T00:00:00+00:00
                              duration: 7
                              startDate: 2025-01-01T00:00:00+00:00
                              expireDate: 2025-01-01T00:00:00+00:00
                              cancelDate: null
                              price: 0
                              regularPrice: 4.99
                              discount: 0
                              earningId: 0
                              action: subscribe
                              type: trial
                              offerStart: 2025-01-01T00:00:00+00:00
                              offerEnd: 2025-01-01T00:00:00+00:00
                              isCurrent: true
                          hasActivePaidSubscriptions: false
                        canTrialSend: false
                        isBlocked: false
                        promoOffers:
                          - id: 123
                            subscribeDays: 7
                            createdAt: 2025-01-01T00:00:00+00:00
                            expiredAt: 2025-01-01T00:00:00+00:00
                            finishedAt: 2025-01-01T00:00:00+00:00
                            subscriberId: "123"
                            userId: "123"
                    offset: 0
                    hasMore: false
                  _pagination:
                    next_page: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999226
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49951
                properties:
                  data:
                    type: object
                    properties:
                      users:
                        type: array
                        example:
                          - view: x
                            avatar: https://public.onlyfans.com/files/l/la/lal/.../123/avatar.jpg
                            avatarThumbs:
                              c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/l/la/lal/.../123/avatar.jpg
                              c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/l/la/lal/.../123/avatar.jpg
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 123
                            name: name
                            username: username
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: true
                            canPayInternal: true
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: true
                            canAddSubscriber: true
                            subscribePrice: 4.99
                            subscriptionBundles: []
                            displayName: ""
                            notice: ""
                            isPaywallRequired: true
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: 6 days
                            listsStates:
                              - id: following
                                type: following
                                name: Following
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              - id: fans
                                type: fans
                                name: Fans
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              - id: recent
                                type: recent
                                name: Recent (last 24 hours)
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              - id: tagged
                                type: tagged
                                name: Tagged
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              - id: friends
                                type: friends
                                name: Friends
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                              - id: muted
                                type: muted
                                name: Muted
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                            canReport: false
                            canReceiveChatMessage: true
                            hideChat: false
                            lastSeen: 2025-01-01T00:00:00+00:00
                            isPerformer: true
                            isRealPerformer: true
                            subscribedByData: null
                            subscribedOnData:
                              price: 0
                              newPrice: 0
                              regularPrice: 0
                              subscribePrice: 0
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: 2025-01-01T00:00:00+00:00
                              expiredAt: 2025-01-01T00:00:00+00:00
                              renewedAt: null
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: Set to Expire
                              isMuted: false
                              unsubscribeReason: No reason given
                              duration: 6 days
                              tipsSumm: 0
                              subscribesSumm: 0
                              messagesSumm: 0
                              postsSumm: 0
                              streamsSumm: 0
                              totalSumm: 0
                              lastActivity: 2025-01-01T00:00:00+00:00
                              recommendations: 0
                              subscribes:
                                - id: 123
                                  userId: 123
                                  subscriberId: 123
                                  date: 2025-01-01T00:00:00+00:00
                                  duration: 7
                                  startDate: 2025-01-01T00:00:00+00:00
                                  expireDate: 2025-01-01T00:00:00+00:00
                                  cancelDate: null
                                  price: 0
                                  regularPrice: 4.99
                                  discount: 0
                                  earningId: 0
                                  action: subscribe
                                  type: trial
                                  offerStart: 2025-01-01T00:00:00+00:00
                                  offerEnd: 2025-01-01T00:00:00+00:00
                                  isCurrent: true
                              hasActivePaidSubscriptions: false
                            canTrialSend: false
                            isBlocked: false
                            promoOffers:
                              - id: 123
                                subscribeDays: 7
                                createdAt: 2025-01-01T00:00:00+00:00
                                expiredAt: 2025-01-01T00:00:00+00:00
                                finishedAt: 2025-01-01T00:00:00+00:00
                                subscriberId: "123"
                                userId: "123"
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: x
                            avatar:
                              type: string
                              example: https://public.onlyfans.com/files/l/la/lal/.../123/avatar.jpg
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/c50/l/la/lal/.../123/avatar.jpg
                                c144:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/c144/l/la/lal/.../123/avatar.jpg
                            header:
                              type: string
                              example: null
                              nullable: true
                            headerSize:
                              type: string
                              example: null
                              nullable: true
                            headerThumbs:
                              type: string
                              example: null
                              nullable: true
                            id:
                              type: integer
                              example: 123
                            name:
                              type: string
                              example: name
                            username:
                              type: string
                              example: username
                            canLookStory:
                              type: boolean
                              example: false
                            canCommentStory:
                              type: boolean
                              example: false
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: true
                            canPayInternal:
                              type: boolean
                              example: true
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: false
                            tipsTextEnabled:
                              type: boolean
                              example: true
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: true
                            canAddSubscriber:
                              type: boolean
                              example: true
                            subscribePrice:
                              type: number
                              example: 4.99
                            subscriptionBundles:
                              type: array
                              example: []
                            displayName:
                              type: string
                              example: ""
                            notice:
                              type: string
                              example: ""
                            isPaywallRequired:
                              type: boolean
                              example: true
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: false
                            subscribedByExpire:
                              type: string
                              example: null
                              nullable: true
                            subscribedByExpireDate:
                              type: string
                              example: null
                              nullable: true
                            subscribedByAutoprolong:
                              type: string
                              example: null
                              nullable: true
                            subscribedIsExpiredNow:
                              type: string
                              example: null
                              nullable: true
                            currentSubscribePrice:
                              type: string
                              example: null
                              nullable: true
                            subscribedOn:
                              type: boolean
                              example: true
                            subscribedOnExpiredNow:
                              type: boolean
                              example: false
                            subscribedOnDuration:
                              type: string
                              example: 6 days
                            listsStates:
                              type: array
                              example:
                                - id: following
                                  type: following
                                  name: Following
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                - id: fans
                                  type: fans
                                  name: Fans
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                - id: recent
                                  type: recent
                                  name: Recent (last 24 hours)
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                - id: tagged
                                  type: tagged
                                  name: Tagged
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                - id: friends
                                  type: friends
                                  name: Friends
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                                - id: muted
                                  type: muted
                                  name: Muted
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: following
                                  type:
                                    type: string
                                    example: following
                                  name:
                                    type: string
                                    example: Following
                                  hasUser:
                                    type: boolean
                                    example: false
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: SYSTEM_LIST
                            canReport:
                              type: boolean
                              example: false
                            canReceiveChatMessage:
                              type: boolean
                              example: true
                            hideChat:
                              type: boolean
                              example: false
                            lastSeen:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            isPerformer:
                              type: boolean
                              example: true
                            isRealPerformer:
                              type: boolean
                              example: true
                            subscribedByData:
                              type: string
                              example: null
                              nullable: true
                            subscribedOnData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: integer
                                  example: 0
                                subscribePrice:
                                  type: integer
                                  example: 0
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                expiredAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                renewedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                discountFinishedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                discountStartedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                status:
                                  type: string
                                  example: Set to Expire
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: No reason given
                                duration:
                                  type: string
                                  example: 6 days
                                tipsSumm:
                                  type: integer
                                  example: 0
                                subscribesSumm:
                                  type: integer
                                  example: 0
                                messagesSumm:
                                  type: integer
                                  example: 0
                                postsSumm:
                                  type: integer
                                  example: 0
                                streamsSumm:
                                  type: integer
                                  example: 0
                                totalSumm:
                                  type: integer
                                  example: 0
                                lastActivity:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                recommendations:
                                  type: integer
                                  example: 0
                                subscribes:
                                  type: array
                                  example:
                                    - id: 123
                                      userId: 123
                                      subscriberId: 123
                                      date: 2025-01-01T00:00:00+00:00
                                      duration: 7
                                      startDate: 2025-01-01T00:00:00+00:00
                                      expireDate: 2025-01-01T00:00:00+00:00
                                      cancelDate: null
                                      price: 0
                                      regularPrice: 4.99
                                      discount: 0
                                      earningId: 0
                                      action: subscribe
                                      type: trial
                                      offerStart: 2025-01-01T00:00:00+00:00
                                      offerEnd: 2025-01-01T00:00:00+00:00
                                      isCurrent: true
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                        example: 123
                                      userId:
                                        type: integer
                                        example: 123
                                      subscriberId:
                                        type: integer
                                        example: 123
                                      date:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      duration:
                                        type: integer
                                        example: 7
                                      startDate:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      expireDate:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      cancelDate:
                                        type: string
                                        example: null
                                        nullable: true
                                      price:
                                        type: integer
                                        example: 0
                                      regularPrice:
                                        type: number
                                        example: 4.99
                                      discount:
                                        type: integer
                                        example: 0
                                      earningId:
                                        type: integer
                                        example: 0
                                      action:
                                        type: string
                                        example: subscribe
                                      type:
                                        type: string
                                        example: trial
                                      offerStart:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      offerEnd:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      isCurrent:
                                        type: boolean
                                        example: true
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            canTrialSend:
                              type: boolean
                              example: false
                            isBlocked:
                              type: boolean
                              example: false
                            promoOffers:
                              type: array
                              example:
                                - id: 123
                                  subscribeDays: 7
                                  createdAt: 2025-01-01T00:00:00+00:00
                                  expiredAt: 2025-01-01T00:00:00+00:00
                                  finishedAt: 2025-01-01T00:00:00+00:00
                                  subscriberId: "123"
                                  userId: "123"
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  subscribeDays:
                                    type: integer
                                    example: 7
                                  createdAt:
                                    type: string
                                    example: 2025-01-01T00:00:00+00:00
                                  expiredAt:
                                    type: string
                                    example: 2025-01-01T00:00:00+00:00
                                  finishedAt:
                                    type: string
                                    example: 2025-01-01T00:00:00+00:00
                                  subscriberId:
                                    type: string
                                    example: "123"
                                  userId:
                                    type: string
                                    example: "123"
                      offset:
                        type: integer
                        example: 0
                      hasMore:
                        type: boolean
                        example: false
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: null
                        nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999226
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49951
      tags:
        - Fans
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Top Fans (/api-reference/fans/list-top-fans)

Get a list of top fans sorted by spending. Filterable by total, subscriptions, tips, messages, posts, or streams.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/fans/top
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/fans/top:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Top Fans
      operationId: listTopFans
      description: Get a list of top fans sorted by spending. Filterable by total,
        subscriptions, tips, messages, posts, or streams.
      parameters:
        - in: query
          name: start_date
          description: Start date for filtering (required with end_date). Must be a valid
            date. Must not be greater than 255 characters.
          example: 2024-01-01
          required: false
          schema:
            type: string
            description: Start date for filtering (required with end_date). Must be a valid
              date. Must not be greater than 255 characters.
            example: 2024-01-01
            nullable: true
        - in: query
          name: end_date
          description: End date for filtering (required with start_date). Must be a valid
            date. Must not be greater than 255 characters.
          example: 2024-12-31
          required: false
          schema:
            type: string
            description: End date for filtering (required with start_date). Must be a valid
              date. Must not be greater than 255 characters.
            example: 2024-12-31
            nullable: true
        - in: query
          name: by
          description: "Sort by: total (default), subscribes, tips, messages, post,
            streams."
          example: total
          required: false
          schema:
            type: string
            description: "Sort by: total (default), subscribes, tips, messages, post,
              streams."
            example: total
            enum:
              - total
              - subscribes
              - tips
              - messages
              - post
              - streams
            nullable: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    users:
                      - view: x
                        avatar: https://public.onlyfans.com/files/l/la/lal/.../123/avatar.jpg
                        avatarThumbs:
                          c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/l/la/lal/.../123/avatar.jpg
                          c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/l/la/lal/.../123/avatar.jpg
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 123
                        name: name
                        username: username
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: true
                        canPayInternal: true
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: true
                        canAddSubscriber: true
                        subscribePrice: 4.99
                        subscriptionBundles: []
                        displayName: ""
                        notice: ""
                        isPaywallRequired: true
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: 6 days
                        listsStates:
                          - id: following
                            type: following
                            name: Following
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: fans
                            type: fans
                            name: Fans
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                        canReport: false
                        canReceiveChatMessage: true
                        hideChat: false
                        lastSeen: 2025-01-01T00:00:00+00:00
                        isPerformer: true
                        isRealPerformer: true
                        subscribedByData: null
                        subscribedOnData:
                          price: 0
                          newPrice: 0
                          regularPrice: 0
                          subscribePrice: 0
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: 2025-01-01T00:00:00+00:00
                          expiredAt: 2025-01-01T00:00:00+00:00
                          renewedAt: null
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: Set to Expire
                          isMuted: false
                          unsubscribeReason: No reason given
                          duration: 6 days
                          tipsSumm: 500
                          subscribesSumm: 100
                          messagesSumm: 200
                          postsSumm: 50
                          streamsSumm: 25
                          totalSumm: 875
                          lastActivity: 2025-01-01T00:00:00+00:00
                          recommendations: 0
                        canTrialSend: false
                        isBlocked: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999226
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49951
                properties:
                  data:
                    type: object
                    properties:
                      users:
                        type: array
                        example:
                          - view: x
                            avatar: https://public.onlyfans.com/files/l/la/lal/.../123/avatar.jpg
                            avatarThumbs:
                              c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/l/la/lal/.../123/avatar.jpg
                              c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/l/la/lal/.../123/avatar.jpg
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 123
                            name: name
                            username: username
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: true
                            canPayInternal: true
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: true
                            canAddSubscriber: true
                            subscribePrice: 4.99
                            subscriptionBundles: []
                            displayName: ""
                            notice: ""
                            isPaywallRequired: true
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: 6 days
                            listsStates:
                              - id: following
                                type: following
                                name: Following
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              - id: fans
                                type: fans
                                name: Fans
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                            canReport: false
                            canReceiveChatMessage: true
                            hideChat: false
                            lastSeen: 2025-01-01T00:00:00+00:00
                            isPerformer: true
                            isRealPerformer: true
                            subscribedByData: null
                            subscribedOnData:
                              price: 0
                              newPrice: 0
                              regularPrice: 0
                              subscribePrice: 0
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: 2025-01-01T00:00:00+00:00
                              expiredAt: 2025-01-01T00:00:00+00:00
                              renewedAt: null
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: Set to Expire
                              isMuted: false
                              unsubscribeReason: No reason given
                              duration: 6 days
                              tipsSumm: 500
                              subscribesSumm: 100
                              messagesSumm: 200
                              postsSumm: 50
                              streamsSumm: 25
                              totalSumm: 875
                              lastActivity: 2025-01-01T00:00:00+00:00
                              recommendations: 0
                            canTrialSend: false
                            isBlocked: false
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: x
                            avatar:
                              type: string
                              example: https://public.onlyfans.com/files/l/la/lal/.../123/avatar.jpg
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/c50/l/la/lal/.../123/avatar.jpg
                                c144:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/c144/l/la/lal/.../123/avatar.jpg
                            header:
                              type: string
                              example: null
                              nullable: true
                            headerSize:
                              type: string
                              example: null
                              nullable: true
                            headerThumbs:
                              type: string
                              example: null
                              nullable: true
                            id:
                              type: integer
                              example: 123
                            name:
                              type: string
                              example: name
                            username:
                              type: string
                              example: username
                            canLookStory:
                              type: boolean
                              example: false
                            canCommentStory:
                              type: boolean
                              example: false
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: true
                            canPayInternal:
                              type: boolean
                              example: true
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: false
                            tipsTextEnabled:
                              type: boolean
                              example: true
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: true
                            canAddSubscriber:
                              type: boolean
                              example: true
                            subscribePrice:
                              type: number
                              example: 4.99
                            subscriptionBundles:
                              type: array
                              example: []
                            displayName:
                              type: string
                              example: ""
                            notice:
                              type: string
                              example: ""
                            isPaywallRequired:
                              type: boolean
                              example: true
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: false
                            subscribedByExpire:
                              type: string
                              example: null
                              nullable: true
                            subscribedByExpireDate:
                              type: string
                              example: null
                              nullable: true
                            subscribedByAutoprolong:
                              type: string
                              example: null
                              nullable: true
                            subscribedIsExpiredNow:
                              type: string
                              example: null
                              nullable: true
                            currentSubscribePrice:
                              type: string
                              example: null
                              nullable: true
                            subscribedOn:
                              type: boolean
                              example: true
                            subscribedOnExpiredNow:
                              type: boolean
                              example: false
                            subscribedOnDuration:
                              type: string
                              example: 6 days
                            listsStates:
                              type: array
                              example:
                                - id: following
                                  type: following
                                  name: Following
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                - id: fans
                                  type: fans
                                  name: Fans
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: following
                                  type:
                                    type: string
                                    example: following
                                  name:
                                    type: string
                                    example: Following
                                  hasUser:
                                    type: boolean
                                    example: false
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: SYSTEM_LIST
                            canReport:
                              type: boolean
                              example: false
                            canReceiveChatMessage:
                              type: boolean
                              example: true
                            hideChat:
                              type: boolean
                              example: false
                            lastSeen:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            isPerformer:
                              type: boolean
                              example: true
                            isRealPerformer:
                              type: boolean
                              example: true
                            subscribedByData:
                              type: string
                              example: null
                              nullable: true
                            subscribedOnData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: integer
                                  example: 0
                                subscribePrice:
                                  type: integer
                                  example: 0
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                expiredAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                renewedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                discountFinishedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                discountStartedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                status:
                                  type: string
                                  example: Set to Expire
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: No reason given
                                duration:
                                  type: string
                                  example: 6 days
                                tipsSumm:
                                  type: integer
                                  example: 500
                                subscribesSumm:
                                  type: integer
                                  example: 100
                                messagesSumm:
                                  type: integer
                                  example: 200
                                postsSumm:
                                  type: integer
                                  example: 50
                                streamsSumm:
                                  type: integer
                                  example: 25
                                totalSumm:
                                  type: integer
                                  example: 875
                                lastActivity:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                recommendations:
                                  type: integer
                                  example: 0
                            canTrialSend:
                              type: boolean
                              example: false
                            isBlocked:
                              type: boolean
                              example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999226
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49951
      tags:
        - Fans
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Set Fan's Custom Name (/api-reference/fans/set-fans-custom-name)

Change the Fan's Custom Name shown in OnlyFans

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml put /api/{account}/fans/{fan_id}/custom-name
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/fans/{fan_id}/custom-name:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: fan_id
        description: Fan's OnlyFans ID
        example: 11223344
        required: true
        schema:
          type: string
    put:
      summary: Set Fan's Custom Name
      operationId: setFansCustomName
      description: Change the Fan's Custom Name shown in OnlyFans
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    view: x
                    avatar: https://public.onlyfans.com/files/q/...
                    avatarThumbs:
                      c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/q/...
                      c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/q/...
                    header: https://public.onlyfans.com/files/2/2j/2jy/...
                    headerSize:
                      width: 792
                      height: 396
                    headerThumbs:
                      w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/2/2j/2jy/...
                      w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/2/2j/2jy/...
                    id: 11223344
                    name: John Doe
                    username: john-doe
                    canLookStory: false
                    canCommentStory: false
                    hasNotViewedStory: false
                    isVerified: true
                    canPayInternal: true
                    hasScheduledStream: false
                    hasStream: false
                    hasStories: false
                    tipsEnabled: false
                    tipsTextEnabled: false
                    tipsMin: 5
                    tipsMinInternal: 1
                    tipsMax: 200
                    canEarn: true
                    canAddSubscriber: true
                    subscribePrice: 0
                    displayName: 🐳Whale ($100+)
                    notice: ""
                    isPaywallRequired: true
                    isRestricted: false
                    canRestrict: true
                    subscribedBy: null
                    subscribedByExpire: null
                    subscribedByExpireDate: 2022-02-10T19:43:21+00:00
                    subscribedByAutoprolong: null
                    subscribedIsExpiredNow: true
                    currentSubscribePrice: null
                    subscribedOn: null
                    subscribedOnExpiredNow: true
                    subscribedOnDuration: 12 days
                    listsStates:
                      - id: recent
                        type: recent
                        name: Recent (last 24 hours)
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: SYSTEM_LIST
                      - id: following
                        type: following
                        name: Following
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: SYSTEM_LIST
                      - id: 859770744
                        type: bookmarks
                        name: Bookmarks
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                      - id: fans
                        type: fans
                        name: Fans
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: null
                      - id: friends
                        type: friends
                        name: Friends
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                      - id: rebill_off
                        type: rebill_off
                        name: Renew Off
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: null
                      - id: rebill_on
                        type: rebill_on
                        name: Renew On
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: null
                      - id: muted
                        type: muted
                        name: Muted
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                      - id: tagged
                        type: tagged
                        name: Tagged
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: SYSTEM_LIST
                    canReport: true
                    canReceiveChatMessage: false
                    hideChat: false
                    lastSeen: 2025-10-12T23:57:50+00:00
                    isPerformer: true
                    isRealPerformer: true
                    subscribedByData:
                      price: 0
                      newPrice: 0
                      regularPrice: 0
                      subscribePrice: 0
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: 2021-11-12T19:43:21+00:00
                      expiredAt: 2022-02-10T19:43:21+00:00
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: null
                      isMuted: false
                      unsubscribeReason: No reason given
                      duration: 2 months
                      showPostsInFeed: true
                      newPostsAfterExpireCount: 266
                      subscribes: []
                      hasActivePaidSubscriptions: false
                    subscribedOnData:
                      price: 0
                      newPrice: 0
                      regularPrice: 4.99
                      subscribePrice: 4.99
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: 2025-07-30T15:06:53+00:00
                      expiredAt: 2025-08-11T18:04:17+00:00
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: null
                      isMuted: false
                      unsubscribeReason: No reason given
                      duration: 12 days
                      tipsSumm: 0
                      subscribesSumm: 0
                      messagesSumm: 0
                      postsSumm: 0
                      streamsSumm: 0
                      totalSumm: 0
                      subscribes: []
                      hasActivePaidSubscriptions: false
                    canTrialSend: false
                    isBlocked: false
                    isPendingAutoprolong: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 224616
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 997
                      remaining_day: 49987
                properties:
                  data:
                    type: object
                    properties:
                      view:
                        type: string
                        example: x
                      avatar:
                        type: string
                        example: https://public.onlyfans.com/files/q/...
                      avatarThumbs:
                        type: object
                        properties:
                          c50:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/c50/q/...
                          c144:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/c144/q/...
                      header:
                        type: string
                        example: https://public.onlyfans.com/files/2/2j/2jy/...
                      headerSize:
                        type: object
                        properties:
                          width:
                            type: integer
                            example: 792
                          height:
                            type: integer
                            example: 396
                      headerThumbs:
                        type: object
                        properties:
                          w480:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/w480/2/2j/2jy/...
                          w760:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/w760/2/2j/2jy/...
                      id:
                        type: integer
                        example: 11223344
                      name:
                        type: string
                        example: John Doe
                      username:
                        type: string
                        example: john-doe
                      canLookStory:
                        type: boolean
                        example: false
                      canCommentStory:
                        type: boolean
                        example: false
                      hasNotViewedStory:
                        type: boolean
                        example: false
                      isVerified:
                        type: boolean
                        example: true
                      canPayInternal:
                        type: boolean
                        example: true
                      hasScheduledStream:
                        type: boolean
                        example: false
                      hasStream:
                        type: boolean
                        example: false
                      hasStories:
                        type: boolean
                        example: false
                      tipsEnabled:
                        type: boolean
                        example: false
                      tipsTextEnabled:
                        type: boolean
                        example: false
                      tipsMin:
                        type: integer
                        example: 5
                      tipsMinInternal:
                        type: integer
                        example: 1
                      tipsMax:
                        type: integer
                        example: 200
                      canEarn:
                        type: boolean
                        example: true
                      canAddSubscriber:
                        type: boolean
                        example: true
                      subscribePrice:
                        type: integer
                        example: 0
                      displayName:
                        type: string
                        example: 🐳Whale ($100+)
                      notice:
                        type: string
                        example: ""
                      isPaywallRequired:
                        type: boolean
                        example: true
                      isRestricted:
                        type: boolean
                        example: false
                      canRestrict:
                        type: boolean
                        example: true
                      subscribedBy:
                        type: string
                        example: null
                        nullable: true
                      subscribedByExpire:
                        type: string
                        example: null
                        nullable: true
                      subscribedByExpireDate:
                        type: string
                        example: 2022-02-10T19:43:21+00:00
                      subscribedByAutoprolong:
                        type: string
                        example: null
                        nullable: true
                      subscribedIsExpiredNow:
                        type: boolean
                        example: true
                      currentSubscribePrice:
                        type: string
                        example: null
                        nullable: true
                      subscribedOn:
                        type: string
                        example: null
                        nullable: true
                      subscribedOnExpiredNow:
                        type: boolean
                        example: true
                      subscribedOnDuration:
                        type: string
                        example: 12 days
                      listsStates:
                        type: array
                        example:
                          - id: recent
                            type: recent
                            name: Recent (last 24 hours)
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: following
                            type: following
                            name: Following
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: 859770744
                            type: bookmarks
                            name: Bookmarks
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          - id: fans
                            type: fans
                            name: Fans
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          - id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          - id: rebill_off
                            type: rebill_off
                            name: Renew Off
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          - id: rebill_on
                            type: rebill_on
                            name: Renew On
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          - id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          - id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: recent
                            type:
                              type: string
                              example: recent
                            name:
                              type: string
                              example: Recent (last 24 hours)
                            hasUser:
                              type: boolean
                              example: false
                            canAddUser:
                              type: boolean
                              example: false
                            cannotAddUserReason:
                              type: string
                              example: SYSTEM_LIST
                      canReport:
                        type: boolean
                        example: true
                      canReceiveChatMessage:
                        type: boolean
                        example: false
                      hideChat:
                        type: boolean
                        example: false
                      lastSeen:
                        type: string
                        example: 2025-10-12T23:57:50+00:00
                      isPerformer:
                        type: boolean
                        example: true
                      isRealPerformer:
                        type: boolean
                        example: true
                      subscribedByData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: integer
                            example: 0
                          subscribePrice:
                            type: integer
                            example: 0
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: 2021-11-12T19:43:21+00:00
                          expiredAt:
                            type: string
                            example: 2022-02-10T19:43:21+00:00
                          renewedAt:
                            type: string
                            example: null
                            nullable: true
                          discountFinishedAt:
                            type: string
                            example: null
                            nullable: true
                          discountStartedAt:
                            type: string
                            example: null
                            nullable: true
                          status:
                            type: string
                            example: null
                            nullable: true
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: No reason given
                          duration:
                            type: string
                            example: 2 months
                          showPostsInFeed:
                            type: boolean
                            example: true
                          newPostsAfterExpireCount:
                            type: integer
                            example: 266
                          subscribes:
                            type: array
                            example: []
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      subscribedOnData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: number
                            example: 4.99
                          subscribePrice:
                            type: number
                            example: 4.99
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: 2025-07-30T15:06:53+00:00
                          expiredAt:
                            type: string
                            example: 2025-08-11T18:04:17+00:00
                          renewedAt:
                            type: string
                            example: null
                            nullable: true
                          discountFinishedAt:
                            type: string
                            example: null
                            nullable: true
                          discountStartedAt:
                            type: string
                            example: null
                            nullable: true
                          status:
                            type: string
                            example: null
                            nullable: true
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: No reason given
                          duration:
                            type: string
                            example: 12 days
                          tipsSumm:
                            type: integer
                            example: 0
                          subscribesSumm:
                            type: integer
                            example: 0
                          messagesSumm:
                            type: integer
                            example: 0
                          postsSumm:
                            type: integer
                            example: 0
                          streamsSumm:
                            type: integer
                            example: 0
                          totalSumm:
                            type: integer
                            example: 0
                          subscribes:
                            type: array
                            example: []
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      canTrialSend:
                        type: boolean
                        example: false
                      isBlocked:
                        type: boolean
                        example: false
                      isPendingAutoprolong:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 224616
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 49987
      tags:
        - Fans
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                custom_name:
                  type: string
                  description: New Custom Name for a Fan. Send empty string (`""`) or `null` to
                    clear out the custom name.
                  example: 🐳Whale ($100+)
              required:
                - custom_name
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Trending GIFs (/api-reference/giphy/list-trending-gi-fs)

Get trending GIFs from the OnlyFans Giphy proxy. Use the returned `id` as the `giphyId` body param when sending a chat or mass message.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/giphy/trending
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/giphy/trending:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Trending GIFs
      operationId: listTrendingGIFs
      description: Get trending GIFs from the OnlyFans Giphy proxy. Use the returned
        `id` as the `giphyId` body param when sending a chat or mass message.
      parameters:
        - in: query
          name: limit
          description: Number of GIFs to return (default = 10, max = 50)
          example: 10
          required: false
          schema:
            type: integer
            description: Number of GIFs to return (default = 10, max = 50)
            example: 10
        - in: query
          name: offset
          description: Number of GIFs to skip for pagination (default = 0)
          example: 0
          required: false
          schema:
            type: integer
            description: Number of GIFs to skip for pagination (default = 0)
            example: 0
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - type: gif
                      id: WAGC3LeqJvXglm5H7a
                      url: https://giphy.com/gifs/wwe-raw-smackdown-WAGC3LeqJvXglm5H7a
                      slug: wwe-raw-smackdown-WAGC3LeqJvXglm5H7a
                      title: Roman Reigns Indecisiveness GIF by WWE
                      rating: g
                      username: wwe
                      embed_url: https://giphy.com/embed/WAGC3LeqJvXglm5H7a
                      images:
                        original:
                          height: "480"
                          width: "480"
                          url: https://media0.giphy.com/media/WAGC3LeqJvXglm5H7a/giphy.gif
                          mp4: https://media0.giphy.com/media/WAGC3LeqJvXglm5H7a/giphy.mp4
                          webp: https://media0.giphy.com/media/WAGC3LeqJvXglm5H7a/giphy.webp
                        fixed_height:
                          height: "200"
                          width: "200"
                          url: https://media0.giphy.com/media/WAGC3LeqJvXglm5H7a/200.gif
                    - type: gif
                      id: fUQ4rhUZJYiQsas6WD
                      url: https://giphy.com/gifs/muppetwiki-sesame-street-muppets-elmo-fUQ4rhUZJYiQsas6WD
                      slug: muppetwiki-sesame-street-muppets-elmo-fUQ4rhUZJYiQsas6WD
                      title: Happy Sesame Street GIF by Muppet Wiki
                      rating: g
                      username: muppetwiki
                      embed_url: https://giphy.com/embed/fUQ4rhUZJYiQsas6WD
                      images:
                        original:
                          height: "300"
                          width: "400"
                          url: https://media4.giphy.com/media/fUQ4rhUZJYiQsas6WD/giphy.gif
                          mp4: https://media4.giphy.com/media/fUQ4rhUZJYiQsas6WD/giphy.mp4
                          webp: https://media4.giphy.com/media/fUQ4rhUZJYiQsas6WD/giphy.webp
                        fixed_height:
                          height: "200"
                          width: "266"
                          url: https://media4.giphy.com/media/fUQ4rhUZJYiQsas6WD/200.gif
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999999
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49999
                properties:
                  data:
                    type: array
                    example:
                      - type: gif
                        id: WAGC3LeqJvXglm5H7a
                        url: https://giphy.com/gifs/wwe-raw-smackdown-WAGC3LeqJvXglm5H7a
                        slug: wwe-raw-smackdown-WAGC3LeqJvXglm5H7a
                        title: Roman Reigns Indecisiveness GIF by WWE
                        rating: g
                        username: wwe
                        embed_url: https://giphy.com/embed/WAGC3LeqJvXglm5H7a
                        images:
                          original:
                            height: "480"
                            width: "480"
                            url: https://media0.giphy.com/media/WAGC3LeqJvXglm5H7a/giphy.gif
                            mp4: https://media0.giphy.com/media/WAGC3LeqJvXglm5H7a/giphy.mp4
                            webp: https://media0.giphy.com/media/WAGC3LeqJvXglm5H7a/giphy.webp
                          fixed_height:
                            height: "200"
                            width: "200"
                            url: https://media0.giphy.com/media/WAGC3LeqJvXglm5H7a/200.gif
                      - type: gif
                        id: fUQ4rhUZJYiQsas6WD
                        url: https://giphy.com/gifs/muppetwiki-sesame-street-muppets-elmo-fUQ4rhUZJYiQsas6WD
                        slug: muppetwiki-sesame-street-muppets-elmo-fUQ4rhUZJYiQsas6WD
                        title: Happy Sesame Street GIF by Muppet Wiki
                        rating: g
                        username: muppetwiki
                        embed_url: https://giphy.com/embed/fUQ4rhUZJYiQsas6WD
                        images:
                          original:
                            height: "300"
                            width: "400"
                            url: https://media4.giphy.com/media/fUQ4rhUZJYiQsas6WD/giphy.gif
                            mp4: https://media4.giphy.com/media/fUQ4rhUZJYiQsas6WD/giphy.mp4
                            webp: https://media4.giphy.com/media/fUQ4rhUZJYiQsas6WD/giphy.webp
                          fixed_height:
                            height: "200"
                            width: "266"
                            url: https://media4.giphy.com/media/fUQ4rhUZJYiQsas6WD/200.gif
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          example: gif
                        id:
                          type: string
                          example: WAGC3LeqJvXglm5H7a
                        url:
                          type: string
                          example: https://giphy.com/gifs/wwe-raw-smackdown-WAGC3LeqJvXglm5H7a
                        slug:
                          type: string
                          example: wwe-raw-smackdown-WAGC3LeqJvXglm5H7a
                        title:
                          type: string
                          example: Roman Reigns Indecisiveness GIF by WWE
                        rating:
                          type: string
                          example: g
                        username:
                          type: string
                          example: wwe
                        embed_url:
                          type: string
                          example: https://giphy.com/embed/WAGC3LeqJvXglm5H7a
                        images:
                          type: object
                          properties:
                            original:
                              type: object
                              properties:
                                height:
                                  type: string
                                  example: "480"
                                width:
                                  type: string
                                  example: "480"
                                url:
                                  type: string
                                  example: https://media0.giphy.com/media/WAGC3LeqJvXglm5H7a/giphy.gif
                                mp4:
                                  type: string
                                  example: https://media0.giphy.com/media/WAGC3LeqJvXglm5H7a/giphy.mp4
                                webp:
                                  type: string
                                  example: https://media0.giphy.com/media/WAGC3LeqJvXglm5H7a/giphy.webp
                            fixed_height:
                              type: object
                              properties:
                                height:
                                  type: string
                                  example: "200"
                                width:
                                  type: string
                                  example: "200"
                                url:
                                  type: string
                                  example: https://media0.giphy.com/media/WAGC3LeqJvXglm5H7a/200.gif
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999999
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49999
      tags:
        - Giphy
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Search GIFs (/api-reference/giphy/search-gi-fs)

Search GIFs from the OnlyFans Giphy proxy. Use the returned `id` as the `giphyId` body param when sending a chat or mass message.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/giphy/search
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/giphy/search:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Search GIFs
      operationId: searchGIFs
      description: Search GIFs from the OnlyFans Giphy proxy. Use the returned `id` as
        the `giphyId` body param when sending a chat or mass message.
      parameters:
        - in: query
          name: q
          description: The search query.
          example: hello
          required: true
          schema:
            type: string
            description: The search query.
            example: hello
        - in: query
          name: limit
          description: Number of GIFs to return (default = 10, max = 50)
          example: 10
          required: false
          schema:
            type: integer
            description: Number of GIFs to return (default = 10, max = 50)
            example: 10
        - in: query
          name: offset
          description: Number of GIFs to skip for pagination (default = 0)
          example: 0
          required: false
          schema:
            type: integer
            description: Number of GIFs to skip for pagination (default = 0)
            example: 0
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - type: gif
                      id: fUQ4rhUZJYiQsas6WD
                      url: https://giphy.com/gifs/muppetwiki-sesame-street-muppets-elmo-fUQ4rhUZJYiQsas6WD
                      slug: muppetwiki-sesame-street-muppets-elmo-fUQ4rhUZJYiQsas6WD
                      title: Happy Sesame Street GIF by Muppet Wiki
                      rating: g
                      username: muppetwiki
                      embed_url: https://giphy.com/embed/fUQ4rhUZJYiQsas6WD
                      images:
                        original:
                          height: "300"
                          width: "400"
                          url: https://media4.giphy.com/media/fUQ4rhUZJYiQsas6WD/giphy.gif
                          mp4: https://media4.giphy.com/media/fUQ4rhUZJYiQsas6WD/giphy.mp4
                          webp: https://media4.giphy.com/media/fUQ4rhUZJYiQsas6WD/giphy.webp
                        fixed_height:
                          height: "200"
                          width: "266"
                          url: https://media4.giphy.com/media/fUQ4rhUZJYiQsas6WD/200.gif
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999999
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49999
                properties:
                  data:
                    type: array
                    example:
                      - type: gif
                        id: fUQ4rhUZJYiQsas6WD
                        url: https://giphy.com/gifs/muppetwiki-sesame-street-muppets-elmo-fUQ4rhUZJYiQsas6WD
                        slug: muppetwiki-sesame-street-muppets-elmo-fUQ4rhUZJYiQsas6WD
                        title: Happy Sesame Street GIF by Muppet Wiki
                        rating: g
                        username: muppetwiki
                        embed_url: https://giphy.com/embed/fUQ4rhUZJYiQsas6WD
                        images:
                          original:
                            height: "300"
                            width: "400"
                            url: https://media4.giphy.com/media/fUQ4rhUZJYiQsas6WD/giphy.gif
                            mp4: https://media4.giphy.com/media/fUQ4rhUZJYiQsas6WD/giphy.mp4
                            webp: https://media4.giphy.com/media/fUQ4rhUZJYiQsas6WD/giphy.webp
                          fixed_height:
                            height: "200"
                            width: "266"
                            url: https://media4.giphy.com/media/fUQ4rhUZJYiQsas6WD/200.gif
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          example: gif
                        id:
                          type: string
                          example: fUQ4rhUZJYiQsas6WD
                        url:
                          type: string
                          example: https://giphy.com/gifs/muppetwiki-sesame-street-muppets-elmo-fUQ4rhUZJYiQsas6WD
                        slug:
                          type: string
                          example: muppetwiki-sesame-street-muppets-elmo-fUQ4rhUZJYiQsas6WD
                        title:
                          type: string
                          example: Happy Sesame Street GIF by Muppet Wiki
                        rating:
                          type: string
                          example: g
                        username:
                          type: string
                          example: muppetwiki
                        embed_url:
                          type: string
                          example: https://giphy.com/embed/fUQ4rhUZJYiQsas6WD
                        images:
                          type: object
                          properties:
                            original:
                              type: object
                              properties:
                                height:
                                  type: string
                                  example: "300"
                                width:
                                  type: string
                                  example: "400"
                                url:
                                  type: string
                                  example: https://media4.giphy.com/media/fUQ4rhUZJYiQsas6WD/giphy.gif
                                mp4:
                                  type: string
                                  example: https://media4.giphy.com/media/fUQ4rhUZJYiQsas6WD/giphy.mp4
                                webp:
                                  type: string
                                  example: https://media4.giphy.com/media/fUQ4rhUZJYiQsas6WD/giphy.webp
                            fixed_height:
                              type: object
                              properties:
                                height:
                                  type: string
                                  example: "200"
                                width:
                                  type: string
                                  example: "266"
                                url:
                                  type: string
                                  example: https://media4.giphy.com/media/fUQ4rhUZJYiQsas6WD/200.gif
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999999
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49999
      tags:
        - Giphy
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List All Link Tags (/api-reference/link-tags/list-all-link-tags)

Get all existing tags that have been used on free trial links, tracking links, and/or Smart Links for this account. This is a free endpoint.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/link-tags
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/link-tags:
    get:
      summary: List All Link Tags
      operationId: listAllLinkTags
      description: Get all existing tags that have been used on free trial links,
        tracking links, and/or Smart Links for this account. This is a free
        endpoint.
      parameters:
        - in: query
          name: type
          description: Filter by link type. If not provided, returns tags for all types.
          example: trial_links
          required: false
          schema:
            type: string
            description: Filter by link type. If not provided, returns tags for all types.
            example: trial_links
            enum:
              - trial_links
              - tracking_links
              - smart_links
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    tags:
                      - Instagram
                      - TikTok
                      - Twitter
                  _meta:
                    _credits:
                      used: 0
                      balance: 9529
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                properties:
                  data:
                    type: object
                    properties:
                      tags:
                        type: array
                        example:
                          - Instagram
                          - TikTok
                          - Twitter
                        items:
                          type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9529
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
      tags:
        - Link Tags
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Add Free Trial Link Tags (/api-reference/free-trial-links/add-free-trial-link-tags)

Add tags to a specific free trial link. Existing tags are preserved. This is a free endpoint.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/trial-links/{trial_link_id}/tags
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/trial-links/{trial_link_id}/tags:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: trial_link_id
        description: The ID of the trial link
        example: 123456789
        required: true
        schema:
          type: integer
    post:
      summary: Add Free Trial Link Tags
      operationId: addFreeTrialLinkTags
      description: Add tags to a specific free trial link. Existing tags are
        preserved. This is a free endpoint.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    tags:
                      - Instagram
                      - Twitter
                      - TikTok
                  _meta:
                    _credits:
                      used: 0
                      balance: 9529
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                properties:
                  data:
                    type: object
                    properties:
                      tags:
                        type: array
                        example:
                          - Instagram
                          - Twitter
                          - TikTok
                        items:
                          type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9529
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
      tags:
        - Free Trial Links
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tags:
                  type: array
                  description: Array of tag names to add to the trial link.
                  example: '["Instagram", "Twitter"]'
                  items:
                    type: string
              required:
                - tags
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Create Free Trial Link (/api-reference/free-trial-links/create-free-trial-link)

Create a new free trial link for the account

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/trial-links
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/trial-links:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Create Free Trial Link
      operationId: createFreeTrialLink
      description: Create a new free trial link for the account
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    trialLinkName: My new trial link
                    url: https://onlyfans.com/username/trial/code
                    subscribeDays: 123
                    subscribeCounts: 123
                    claimCounts: 123
                    expiredAt: 2025-01-05T00:00:00+00:00
                    createdAt: 2025-01-01T00:00:00+00:00
                    isFinished: false
                  _pagination:
                    next_page: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999840
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49993
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      trialLinkName:
                        type: string
                        example: My new trial link
                      url:
                        type: string
                        example: https://onlyfans.com/username/trial/code
                      subscribeDays:
                        type: integer
                        example: 123
                      subscribeCounts:
                        type: integer
                        example: 123
                      claimCounts:
                        type: integer
                        example: 123
                      expiredAt:
                        type: string
                        example: 2025-01-05T00:00:00+00:00
                      createdAt:
                        type: string
                        example: 2025-01-01T00:00:00+00:00
                      isFinished:
                        type: boolean
                        example: false
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: null
                        nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999840
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49993
      tags:
        - Free Trial Links
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tags:
                  type: array
                  description: Array of tag names to add to the trial link.
                  example: '["Instagram", "Twitter"]'
                  items:
                    type: string
                name:
                  type: string
                  description: The name of the trail link (optional). Cannot be longer than 64
                    characters.
                  example: 7
                  nullable: true
                offerExpiration:
                  type: integer
                  description: The trial link expiration **in days (from now)**. Must either be
                    **0** (to never expire), or a number between **1** and
                    **30**.
                  example: 7
                offerLimit:
                  type: integer
                  description: How many people can use this offer. Must either be **0** (for no
                    limit), or a number between **1**-**10**, **50**, or
                    **100**.
                  example: 7
                  enum:
                    - 0
                    - 1
                    - 2
                    - 3
                    - 4
                    - 5
                    - 6
                    - 7
                    - 8
                    - 9
                    - 10
                    - 50
                    - 100
                duration:
                  type: integer
                  description: The duration of the free trial **in days**. Must be **1**, **3**,
                    **7**, **14**, **30** (1 month), **90** (3 months), **180**
                    (6 months), or **360** (12 months).
                  example: 7
                  enum:
                    - 1
                    - 3
                    - 7
                    - 14
                    - 30
                    - 90
                    - 180
                    - 360
              required:
                - offerExpiration
                - offerLimit
                - duration
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Delete Free Trial Link (/api-reference/free-trial-links/delete-free-trial-link)

Delete a free trial link by its ID

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/trial-links/{trial_link_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/trial-links/{trial_link_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: trial_link_id
        description: The ID of the trial link.
        example: atque
        required: true
        schema:
          type: string
    delete:
      summary: Delete Free Trial Link
      operationId: deleteFreeTrialLink
      description: Delete a free trial link by its ID
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999837
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49990
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999837
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49990
      tags:
        - Free Trial Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Free Trial Link Cohort ARPS (/api-reference/free-trial-links/get-free-trial-link-cohort-arps)

Get per-link time-to-profit cohort ARPS windows for a specific Free Trial Link

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/trial-links/{trial_link_id}/cohort-arps
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/trial-links/{trial_link_id}/cohort-arps:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: trial_link_id
        description: The ID of the trial link.
        example: accusantium
        required: true
        schema:
          type: string
    get:
      summary: Get Free Trial Link Cohort ARPS
      operationId: getFreeTrialLinkCohortARPS
      description: Get per-link time-to-profit cohort ARPS windows for a specific Free
        Trial Link
      parameters:
        - in: query
          name: acquisition_start
          description: Optional acquisition range start date
          example: 2026-01-01T00:00:00Z
          required: false
          schema:
            type: string
            description: Optional acquisition range start date
            example: 2026-01-01T00:00:00Z
        - in: query
          name: acquisition_end
          description: Optional acquisition range end date
          example: 2026-01-31T23:59:59Z
          required: false
          schema:
            type: string
            description: Optional acquisition range end date
            example: 2026-01-31T23:59:59Z
        - in: query
          name: revenue_basis
          description: Revenue basis. Defaults to `net`.
          example: net
          required: false
          schema:
            type: string
            description: Revenue basis. Defaults to `net`.
            example: net
            enum:
              - net
              - gross
      responses:
        "401":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  error: Unauthorized. Go to https://app.onlyfansapi.com/api-keys to get your API
                    key.
                properties:
                  error:
                    type: string
                    example: Unauthorized. Go to https://app.onlyfansapi.com/api-keys to get your
                      API key.
      tags:
        - Free Trial Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Free Trial Link Stats (/api-reference/free-trial-links/get-free-trial-link-stats)

Get dashboard-style summary plus daily and monthly metrics for a specific Free Trial Link

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/trial-links/{trial_link_id}/stats
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/trial-links/{trial_link_id}/stats:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: trial_link_id
        description: The ID of the trial link.
        example: facere
        required: true
        schema:
          type: string
    get:
      summary: Get Free Trial Link Stats
      operationId: getFreeTrialLinkStats
      description: Get dashboard-style summary plus daily and monthly metrics for a
        specific Free Trial Link
      parameters:
        - in: query
          name: date_start
          description: Optional stats range start date
          example: 2026-01-01T00:00:00Z
          required: false
          schema:
            type: string
            description: Optional stats range start date
            example: 2026-01-01T00:00:00Z
        - in: query
          name: date_end
          description: Optional stats range end date
          example: 2026-01-31T23:59:59Z
          required: false
          schema:
            type: string
            description: Optional stats range end date
            example: 2026-01-31T23:59:59Z
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    summary:
                      clicks_total: 182
                      subs_total: 123
                      revenue_total: 123
                      spenders_total: 16
                      revenue_cached_at: 2026-01-31T23:59:59+00:00
                    daily_metrics:
                      - timestamp: 2026-01-30
                        clicks: 5
                        subs: 3
                        revenue: 12.5
                        spenders: 1
                      - timestamp: 2026-01-31
                        clicks: 8
                        subs: 4
                        revenue: 21
                        spenders: 2
                    monthly_metrics:
                      - timestamp: 2026-01-01
                        clicks: 182
                        subs: 123
                        revenue: 123
                        spenders: 16
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                properties:
                  data:
                    type: object
                    properties:
                      summary:
                        type: object
                        properties:
                          clicks_total:
                            type: integer
                            example: 182
                          subs_total:
                            type: integer
                            example: 123
                          revenue_total:
                            type: number
                            example: 123
                          spenders_total:
                            type: integer
                            example: 16
                          revenue_cached_at:
                            type: string
                            example: 2026-01-31T23:59:59+00:00
                      daily_metrics:
                        type: array
                        example:
                          - timestamp: 2026-01-30
                            clicks: 5
                            subs: 3
                            revenue: 12.5
                            spenders: 1
                          - timestamp: 2026-01-31
                            clicks: 8
                            subs: 4
                            revenue: 21
                            spenders: 2
                        items:
                          type: object
                          properties:
                            timestamp:
                              type: string
                              example: 2026-01-30
                            clicks:
                              type: integer
                              example: 5
                            subs:
                              type: integer
                              example: 3
                            revenue:
                              type: number
                              example: 12.5
                            spenders:
                              type: integer
                              example: 1
                      monthly_metrics:
                        type: array
                        example:
                          - timestamp: 2026-01-01
                            clicks: 182
                            subs: 123
                            revenue: 123
                            spenders: 16
                        items:
                          type: object
                          properties:
                            timestamp:
                              type: string
                              example: 2026-01-01
                            clicks:
                              type: integer
                              example: 182
                            subs:
                              type: integer
                              example: 123
                            revenue:
                              type: number
                              example: 123
                            spenders:
                              type: integer
                              example: 16
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
      tags:
        - Free Trial Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Free Trial Link (/api-reference/free-trial-links/get-free-trial-link)

Get individual Free Trial Link details and it's revenue data

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/trial-links/{trial_link_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/trial-links/{trial_link_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: trial_link_id
        description: The ID of the trial link.
        example: atque
        required: true
        schema:
          type: string
    get:
      summary: Get Free Trial Link
      operationId: getFreeTrialLink
      description: Get individual Free Trial Link details and it's revenue data
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    trialLinkName: Trial link name
                    url: https://onlyfans.com/username/trial/abc123
                    subscribeDays: 30
                    subscribeCounts: 0
                    claimCounts: 123
                    clicksCounts: 182
                    expiredAt: null
                    createdAt: 2025-01-01T01:01:01+00:00
                    isFinished: false
                    tags:
                      - Instagram
                      - Twitter
                    revenue:
                      total: 123
                      revenuePerSubscriber: 12
                      spendersCount: 16
                      calculatedAt: 2025-01-01T01:01:01+00:00
                      isLoading: false
                    cost:
                      inputMode: null
                      inputValue: null
                      perSub: null
                      perClick: null
                      perPromo: null
                      subscriberSourceCount: 123
                      clickSourceCount: 182
                    links:
                      related:
                        subscribers: https://app.onlyfansapi.com/api/acct_abc123/trial-links/123/subscribers
                  _meta:
                    _credits:
                      used: 1
                      balance: 7095551
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4998
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      trialLinkName:
                        type: string
                        example: Trial link name
                      url:
                        type: string
                        example: https://onlyfans.com/username/trial/abc123
                      subscribeDays:
                        type: integer
                        example: 30
                      subscribeCounts:
                        type: integer
                        example: 0
                      claimCounts:
                        type: integer
                        example: 123
                      clicksCounts:
                        type: integer
                        example: 182
                      expiredAt:
                        type: string
                        example: null
                        nullable: true
                      createdAt:
                        type: string
                        example: 2025-01-01T01:01:01+00:00
                      isFinished:
                        type: boolean
                        example: false
                      tags:
                        type: array
                        example:
                          - Instagram
                          - Twitter
                        items:
                          type: string
                      revenue:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 123
                          revenuePerSubscriber:
                            type: number
                            example: 12
                          spendersCount:
                            type: integer
                            example: 16
                          calculatedAt:
                            type: string
                            example: 2025-01-01T01:01:01+00:00
                          isLoading:
                            type: boolean
                            example: false
                      cost:
                        type: object
                        properties:
                          inputMode:
                            type: string
                            example: null
                            nullable: true
                          inputValue:
                            type: string
                            example: null
                            nullable: true
                          perSub:
                            type: string
                            example: null
                            nullable: true
                          perClick:
                            type: string
                            example: null
                            nullable: true
                          perPromo:
                            type: string
                            example: null
                            nullable: true
                          subscriberSourceCount:
                            type: integer
                            example: 123
                          clickSourceCount:
                            type: integer
                            example: 182
                      links:
                        type: object
                        properties:
                          related:
                            type: object
                            properties:
                              subscribers:
                                type: string
                                example: https://app.onlyfansapi.com/api/acct_abc123/trial-links/123/subscribers
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 7095551
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4998
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Free Trial Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Introduction (/api-reference/free-trial-links)

import {
    ChartPieIcon,
    LayersIcon
} from 'lucide-react';

Through our API, you are able to create and manage free trial links, as well as retrieve advanced analytics on their performance, spenders and subscribers.

### A note on our calculation logic \[!toc]

<Cards>
  <Card icon={<LayersIcon className="text-fd-primary" />} title="Link Stacking">
    We take link stacking into account (e.g., multiple free trial links stacked on top of each other) and divide the revenue equally between them.
  </Card>

  <Card icon={<ChartPieIcon className="text-fd-primary" />} title="Spendings">
    We only track the fan’s spending during the period through which they have been subscribed.
  </Card>
</Cards>

# List Free Trial Link Spenders (/api-reference/free-trial-links/list-free-trial-link-spenders)

Only available if we already scraped subscribers and calculated revenue per fan

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/trial-links/{trial_link_id}/spenders
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/trial-links/{trial_link_id}/spenders:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: trial_link_id
        description: The ID of the free trial link to get spenders for
        example: 123456789
        required: true
        schema:
          type: string
    get:
      summary: List Free Trial Link Spenders
      operationId: listFreeTrialLinkSpenders
      description: Only available if we already scraped subscribers and calculated
        revenue per fan
      parameters:
        - in: query
          name: limit
          description: The number of spenders to return per page. Default `50`.
          example: 50
          required: false
          schema:
            type: integer
            description: The number of spenders to return per page. Default `50`.
            example: 50
        - in: query
          name: offset
          description: The offset used for pagination. Default `0`.
          example: 0
          required: false
          schema:
            type: integer
            description: The offset used for pagination. Default `0`.
            example: 0
        - in: query
          name: minSpend
          description: Minimal spend of a fan. Default `1`. Must be at least 1.
          example: 1
          required: false
          schema:
            type: number
            description: Minimal spend of a fan. Default `1`. Must be at least 1.
            example: 1
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - onlyfans_id: "100000001"
                      username: user_001
                      revenue:
                        total: 26.8
                        calculated_at: 2025-09-29T10:47:19.000000Z
                    - onlyfans_id: "100000002"
                      username: user_002
                      revenue:
                        total: 109.88
                        calculated_at: 2025-09-29T10:47:19.000000Z
                    - onlyfans_id: "100000003"
                      username: user_003
                      revenue:
                        total: 32.96
                        calculated_at: 2025-09-29T10:47:19.000000Z
                  _meta:
                    _credits:
                      used: 1
                      balance: 224802
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 994
                      remaining_day: 49929
                properties:
                  data:
                    type: array
                    example:
                      - onlyfans_id: "100000001"
                        username: user_001
                        revenue:
                          total: 26.8
                          calculated_at: 2025-09-29T10:47:19.000000Z
                      - onlyfans_id: "100000002"
                        username: user_002
                        revenue:
                          total: 109.88
                          calculated_at: 2025-09-29T10:47:19.000000Z
                      - onlyfans_id: "100000003"
                        username: user_003
                        revenue:
                          total: 32.96
                          calculated_at: 2025-09-29T10:47:19.000000Z
                    items:
                      type: object
                      properties:
                        onlyfans_id:
                          type: string
                          example: "100000001"
                        username:
                          type: string
                          example: user_001
                        revenue:
                          type: object
                          properties:
                            total:
                              type: number
                              example: 26.8
                            calculated_at:
                              type: string
                              example: 2025-09-29T10:47:19.000000Z
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 224802
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 994
                          remaining_day:
                            type: integer
                            example: 49929
      tags:
        - Free Trial Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Free Trial Link Subscribers (/api-reference/free-trial-links/list-free-trial-link-subscribers)

Get list of subscribers who joined through a Free Trial Link

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/trial-links/{trial_link_id}/subscribers
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/trial-links/{trial_link_id}/subscribers:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: trial_link_id
        description: The ID of the trial link.
        example: necessitatibus
        required: true
        schema:
          type: string
    get:
      summary: List Free Trial Link Subscribers
      operationId: listFreeTrialLinkSubscribers
      description: Get list of subscribers who joined through a Free Trial Link
      parameters:
        - in: query
          name: limit
          description: The number of subscribers to return per page. Default `10`
          example: 10
          required: true
          schema:
            type: integer
            description: The number of subscribers to return per page. Default `10`
            example: 10
        - in: query
          name: offset
          description: The offset used for pagination. Default `0`
          example: 0
          required: true
          schema:
            type: integer
            description: The offset used for pagination. Default `0`
            example: 0
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - view: x
                        avatar: https://public.onlyfans.com/files/.../avatar.jpg
                        avatarThumbs:
                          c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/.../avatar.jpg
                          c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/.../avatar.jpg
                        header: https://public.onlyfans.com/files/.../header.jpg
                        headerSize:
                          width: 2160
                          height: 2700
                        headerThumbs:
                          w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/.../header.jpg
                          w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/.../header.jpg
                        id: 123
                        name: name
                        username: username
                        canLookStory: true
                        canCommentStory: true
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: true
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: ""
                        notice: ""
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: true
                        subscribedByExpire: false
                        subscribedByExpireDate: 2025-01-01T00:00:00+00:00
                        subscribedByAutoprolong: true
                        subscribedIsExpiredNow: false
                        currentSubscribePrice: 0
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: 3 days
                        listsStates:
                          - id: fans
                            type: fans
                            name: Fans
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: USER_NOT_PERFORMER
                          - id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          - id: recent
                            type: recent
                            name: Recent (last 24 hours)
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: rebill_off
                            type: rebill_off
                            name: Renew Off
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: rebill_on
                            type: rebill_on
                            name: Renew On
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          - id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                        canReport: true
                        canReceiveChatMessage: true
                        hideChat: false
                        lastSeen: 2025-01-01T00:00:00+00:00
                        isPerformer: false
                        isRealPerformer: false
                        subscribedByData:
                          price: 0
                          newPrice: 0
                          regularPrice: 0
                          subscribePrice: 0
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: 2025-01-01T00:00:00+00:00
                          expiredAt: 2025-01-01T00:00:00+00:00
                          renewedAt: 2025-01-01T00:00:00+00:00
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: null
                          isMuted: false
                          unsubscribeReason: No reason given
                          duration: 3 days
                          showPostsInFeed: true
                          subscribes:
                            - id: 123
                              userId: 123
                              subscriberId: 123
                              date: 2025-01-01T00:00:00+00:00
                              duration: 123
                              startDate: 2025-01-01T00:00:00+00:00
                              expireDate: 2025-01-01T00:00:00+00:00
                              cancelDate: null
                              price: 0
                              regularPrice: 0
                              discount: 0
                              earningId: 0
                              action: subscribe
                              type: auto
                              offerStart: null
                              offerEnd: null
                              isCurrent: true
                          hasActivePaidSubscriptions: false
                        subscribedOnData:
                          price: 0
                          newPrice: 0
                          regularPrice: 5
                          subscribePrice: 5
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: 2025-01-01T00:00:00+00:00
                          expiredAt: 2025-01-01T00:00:00+00:00
                          renewedAt: null
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: Set to Expire
                          isMuted: false
                          unsubscribeReason: No reason given
                          duration: 3 days
                          tipsSumm: 0
                          subscribesSumm: 0
                          messagesSumm: 0
                          postsSumm: 0
                          streamsSumm: 0
                          totalSumm: 0
                          lastActivity: 2025-01-01T00:00:00+00:00
                          recommendations: 0
                          subscribes:
                            - id: 123
                              userId: 123
                              subscriberId: 123
                              date: 2025-01-01T00:00:00+00:00
                              duration: 90
                              startDate: 2025-01-01T00:00:00+00:00
                              expireDate: 2025-01-01T00:00:00+00:00
                              cancelDate: null
                              price: 0
                              regularPrice: 5
                              discount: 0
                              earningId: 0
                              action: subscribe
                              type: trial
                              offerStart: 2025-01-01T00:00:00+00:00
                              offerEnd: null
                              isCurrent: true
                          hasActivePaidSubscriptions: false
                        canTrialSend: false
                        isBlocked: false
                        promoOffers:
                          - id: 123
                            subscribeDays: 90
                            createdAt: 2025-01-01T00:00:00+00:00
                            expiredAt: null
                            finishedAt: 2025-01-01T00:00:00+00:00
                            subscriberId: "123"
                            userId: "123"
                        canUnsubscribe: true
                        isPendingAutoprolong: false
                    hasMore: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000000028
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49998
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - view: x
                            avatar: https://public.onlyfans.com/files/.../avatar.jpg
                            avatarThumbs:
                              c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/.../avatar.jpg
                              c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/.../avatar.jpg
                            header: https://public.onlyfans.com/files/.../header.jpg
                            headerSize:
                              width: 2160
                              height: 2700
                            headerThumbs:
                              w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/.../header.jpg
                              w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/.../header.jpg
                            id: 123
                            name: name
                            username: username
                            canLookStory: true
                            canCommentStory: true
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: true
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            displayName: ""
                            notice: ""
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: true
                            subscribedByExpire: false
                            subscribedByExpireDate: 2025-01-01T00:00:00+00:00
                            subscribedByAutoprolong: true
                            subscribedIsExpiredNow: false
                            currentSubscribePrice: 0
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: 3 days
                            listsStates:
                              - id: fans
                                type: fans
                                name: Fans
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              - id: following
                                type: following
                                name: Following
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              - id: friends
                                type: friends
                                name: Friends
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: USER_NOT_PERFORMER
                              - id: muted
                                type: muted
                                name: Muted
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                              - id: recent
                                type: recent
                                name: Recent (last 24 hours)
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              - id: rebill_off
                                type: rebill_off
                                name: Renew Off
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              - id: rebill_on
                                type: rebill_on
                                name: Renew On
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: null
                              - id: tagged
                                type: tagged
                                name: Tagged
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                            canReport: true
                            canReceiveChatMessage: true
                            hideChat: false
                            lastSeen: 2025-01-01T00:00:00+00:00
                            isPerformer: false
                            isRealPerformer: false
                            subscribedByData:
                              price: 0
                              newPrice: 0
                              regularPrice: 0
                              subscribePrice: 0
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: 2025-01-01T00:00:00+00:00
                              expiredAt: 2025-01-01T00:00:00+00:00
                              renewedAt: 2025-01-01T00:00:00+00:00
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: null
                              isMuted: false
                              unsubscribeReason: No reason given
                              duration: 3 days
                              showPostsInFeed: true
                              subscribes:
                                - id: 123
                                  userId: 123
                                  subscriberId: 123
                                  date: 2025-01-01T00:00:00+00:00
                                  duration: 123
                                  startDate: 2025-01-01T00:00:00+00:00
                                  expireDate: 2025-01-01T00:00:00+00:00
                                  cancelDate: null
                                  price: 0
                                  regularPrice: 0
                                  discount: 0
                                  earningId: 0
                                  action: subscribe
                                  type: auto
                                  offerStart: null
                                  offerEnd: null
                                  isCurrent: true
                              hasActivePaidSubscriptions: false
                            subscribedOnData:
                              price: 0
                              newPrice: 0
                              regularPrice: 5
                              subscribePrice: 5
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: 2025-01-01T00:00:00+00:00
                              expiredAt: 2025-01-01T00:00:00+00:00
                              renewedAt: null
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: Set to Expire
                              isMuted: false
                              unsubscribeReason: No reason given
                              duration: 3 days
                              tipsSumm: 0
                              subscribesSumm: 0
                              messagesSumm: 0
                              postsSumm: 0
                              streamsSumm: 0
                              totalSumm: 0
                              lastActivity: 2025-01-01T00:00:00+00:00
                              recommendations: 0
                              subscribes:
                                - id: 123
                                  userId: 123
                                  subscriberId: 123
                                  date: 2025-01-01T00:00:00+00:00
                                  duration: 90
                                  startDate: 2025-01-01T00:00:00+00:00
                                  expireDate: 2025-01-01T00:00:00+00:00
                                  cancelDate: null
                                  price: 0
                                  regularPrice: 5
                                  discount: 0
                                  earningId: 0
                                  action: subscribe
                                  type: trial
                                  offerStart: 2025-01-01T00:00:00+00:00
                                  offerEnd: null
                                  isCurrent: true
                              hasActivePaidSubscriptions: false
                            canTrialSend: false
                            isBlocked: false
                            promoOffers:
                              - id: 123
                                subscribeDays: 90
                                createdAt: 2025-01-01T00:00:00+00:00
                                expiredAt: null
                                finishedAt: 2025-01-01T00:00:00+00:00
                                subscriberId: "123"
                                userId: "123"
                            canUnsubscribe: true
                            isPendingAutoprolong: false
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: x
                            avatar:
                              type: string
                              example: https://public.onlyfans.com/files/.../avatar.jpg
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/c50/.../avatar.jpg
                                c144:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/c144/.../avatar.jpg
                            header:
                              type: string
                              example: https://public.onlyfans.com/files/.../header.jpg
                            headerSize:
                              type: object
                              properties:
                                width:
                                  type: integer
                                  example: 2160
                                height:
                                  type: integer
                                  example: 2700
                            headerThumbs:
                              type: object
                              properties:
                                w480:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/w480/.../header.jpg
                                w760:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/w760/.../header.jpg
                            id:
                              type: integer
                              example: 123
                            name:
                              type: string
                              example: name
                            username:
                              type: string
                              example: username
                            canLookStory:
                              type: boolean
                              example: true
                            canCommentStory:
                              type: boolean
                              example: true
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: false
                            canPayInternal:
                              type: boolean
                              example: true
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: false
                            tipsTextEnabled:
                              type: boolean
                              example: true
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: false
                            canAddSubscriber:
                              type: boolean
                              example: false
                            subscribePrice:
                              type: integer
                              example: 0
                            displayName:
                              type: string
                              example: ""
                            notice:
                              type: string
                              example: ""
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: true
                            subscribedByExpire:
                              type: boolean
                              example: false
                            subscribedByExpireDate:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            subscribedByAutoprolong:
                              type: boolean
                              example: true
                            subscribedIsExpiredNow:
                              type: boolean
                              example: false
                            currentSubscribePrice:
                              type: integer
                              example: 0
                            subscribedOn:
                              type: boolean
                              example: true
                            subscribedOnExpiredNow:
                              type: boolean
                              example: false
                            subscribedOnDuration:
                              type: string
                              example: 3 days
                            listsStates:
                              type: array
                              example:
                                - id: fans
                                  type: fans
                                  name: Fans
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                - id: following
                                  type: following
                                  name: Following
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                - id: friends
                                  type: friends
                                  name: Friends
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: USER_NOT_PERFORMER
                                - id: muted
                                  type: muted
                                  name: Muted
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                                - id: recent
                                  type: recent
                                  name: Recent (last 24 hours)
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                - id: rebill_off
                                  type: rebill_off
                                  name: Renew Off
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                - id: rebill_on
                                  type: rebill_on
                                  name: Renew On
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: null
                                - id: tagged
                                  type: tagged
                                  name: Tagged
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: fans
                                  type:
                                    type: string
                                    example: fans
                                  name:
                                    type: string
                                    example: Fans
                                  hasUser:
                                    type: boolean
                                    example: true
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: ALREADY_EXISTS
                            canReport:
                              type: boolean
                              example: true
                            canReceiveChatMessage:
                              type: boolean
                              example: true
                            hideChat:
                              type: boolean
                              example: false
                            lastSeen:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            isPerformer:
                              type: boolean
                              example: false
                            isRealPerformer:
                              type: boolean
                              example: false
                            subscribedByData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: integer
                                  example: 0
                                subscribePrice:
                                  type: integer
                                  example: 0
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                expiredAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                renewedAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                discountFinishedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                discountStartedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                status:
                                  type: string
                                  example: null
                                  nullable: true
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: No reason given
                                duration:
                                  type: string
                                  example: 3 days
                                showPostsInFeed:
                                  type: boolean
                                  example: true
                                subscribes:
                                  type: array
                                  example:
                                    - id: 123
                                      userId: 123
                                      subscriberId: 123
                                      date: 2025-01-01T00:00:00+00:00
                                      duration: 123
                                      startDate: 2025-01-01T00:00:00+00:00
                                      expireDate: 2025-01-01T00:00:00+00:00
                                      cancelDate: null
                                      price: 0
                                      regularPrice: 0
                                      discount: 0
                                      earningId: 0
                                      action: subscribe
                                      type: auto
                                      offerStart: null
                                      offerEnd: null
                                      isCurrent: true
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                        example: 123
                                      userId:
                                        type: integer
                                        example: 123
                                      subscriberId:
                                        type: integer
                                        example: 123
                                      date:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      duration:
                                        type: integer
                                        example: 123
                                      startDate:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      expireDate:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      cancelDate:
                                        type: string
                                        example: null
                                        nullable: true
                                      price:
                                        type: integer
                                        example: 0
                                      regularPrice:
                                        type: integer
                                        example: 0
                                      discount:
                                        type: integer
                                        example: 0
                                      earningId:
                                        type: integer
                                        example: 0
                                      action:
                                        type: string
                                        example: subscribe
                                      type:
                                        type: string
                                        example: auto
                                      offerStart:
                                        type: string
                                        example: null
                                        nullable: true
                                      offerEnd:
                                        type: string
                                        example: null
                                        nullable: true
                                      isCurrent:
                                        type: boolean
                                        example: true
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            subscribedOnData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: integer
                                  example: 5
                                subscribePrice:
                                  type: integer
                                  example: 5
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                expiredAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                renewedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                discountFinishedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                discountStartedAt:
                                  type: string
                                  example: null
                                  nullable: true
                                status:
                                  type: string
                                  example: Set to Expire
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: No reason given
                                duration:
                                  type: string
                                  example: 3 days
                                tipsSumm:
                                  type: integer
                                  example: 0
                                subscribesSumm:
                                  type: integer
                                  example: 0
                                messagesSumm:
                                  type: integer
                                  example: 0
                                postsSumm:
                                  type: integer
                                  example: 0
                                streamsSumm:
                                  type: integer
                                  example: 0
                                totalSumm:
                                  type: integer
                                  example: 0
                                lastActivity:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                recommendations:
                                  type: integer
                                  example: 0
                                subscribes:
                                  type: array
                                  example:
                                    - id: 123
                                      userId: 123
                                      subscriberId: 123
                                      date: 2025-01-01T00:00:00+00:00
                                      duration: 90
                                      startDate: 2025-01-01T00:00:00+00:00
                                      expireDate: 2025-01-01T00:00:00+00:00
                                      cancelDate: null
                                      price: 0
                                      regularPrice: 5
                                      discount: 0
                                      earningId: 0
                                      action: subscribe
                                      type: trial
                                      offerStart: 2025-01-01T00:00:00+00:00
                                      offerEnd: null
                                      isCurrent: true
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                        example: 123
                                      userId:
                                        type: integer
                                        example: 123
                                      subscriberId:
                                        type: integer
                                        example: 123
                                      date:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      duration:
                                        type: integer
                                        example: 90
                                      startDate:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      expireDate:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      cancelDate:
                                        type: string
                                        example: null
                                        nullable: true
                                      price:
                                        type: integer
                                        example: 0
                                      regularPrice:
                                        type: integer
                                        example: 5
                                      discount:
                                        type: integer
                                        example: 0
                                      earningId:
                                        type: integer
                                        example: 0
                                      action:
                                        type: string
                                        example: subscribe
                                      type:
                                        type: string
                                        example: trial
                                      offerStart:
                                        type: string
                                        example: 2025-01-01T00:00:00+00:00
                                      offerEnd:
                                        type: string
                                        example: null
                                        nullable: true
                                      isCurrent:
                                        type: boolean
                                        example: true
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            canTrialSend:
                              type: boolean
                              example: false
                            isBlocked:
                              type: boolean
                              example: false
                            promoOffers:
                              type: array
                              example:
                                - id: 123
                                  subscribeDays: 90
                                  createdAt: 2025-01-01T00:00:00+00:00
                                  expiredAt: null
                                  finishedAt: 2025-01-01T00:00:00+00:00
                                  subscriberId: "123"
                                  userId: "123"
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  subscribeDays:
                                    type: integer
                                    example: 90
                                  createdAt:
                                    type: string
                                    example: 2025-01-01T00:00:00+00:00
                                  expiredAt:
                                    type: string
                                    example: null
                                    nullable: true
                                  finishedAt:
                                    type: string
                                    example: 2025-01-01T00:00:00+00:00
                                  subscriberId:
                                    type: string
                                    example: "123"
                                  userId:
                                    type: string
                                    example: "123"
                            canUnsubscribe:
                              type: boolean
                              example: true
                            isPendingAutoprolong:
                              type: boolean
                              example: false
                      hasMore:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000000028
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49998
      tags:
        - Free Trial Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Free Trial Link Tags (/api-reference/free-trial-links/list-free-trial-link-tags)

Get tags for a specific free trial link. This is a free endpoint.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/trial-links/{trial_link_id}/tags
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/trial-links/{trial_link_id}/tags:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: trial_link_id
        description: The ID of the trial link
        example: 123456789
        required: true
        schema:
          type: integer
    get:
      summary: List Free Trial Link Tags
      operationId: listFreeTrialLinkTags
      description: Get tags for a specific free trial link. This is a free endpoint.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    tags:
                      - Instagram
                      - Twitter
                  _meta:
                    _credits:
                      used: 0
                      balance: 9529
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                properties:
                  data:
                    type: object
                    properties:
                      tags:
                        type: array
                        example:
                          - Instagram
                          - Twitter
                        items:
                          type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9529
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
      tags:
        - Free Trial Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Free Trial Links (/api-reference/free-trial-links/list-free-trial-links)

List all free trial links for the account, including the details and statistics

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/trial-links
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/trial-links:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Free Trial Links
      operationId: listFreeTrialLinks
      description: List all free trial links for the account, including the details
        and statistics
      parameters:
        - in: query
          name: startDate
          description: The start date for trial links. Keep empty to get all. Must not be
            greater than 255 characters.
          example: 2025-01-01 00:00:00
          required: false
          schema:
            type: string
            description: The start date for trial links. Keep empty to get all. Must not be
              greater than 255 characters.
            example: 2025-01-01 00:00:00
            nullable: true
        - in: query
          name: endDate
          description: The end date for trial links. Keep empty to get all. Must not be
            greater than 255 characters.
          example: 2025-01-31 23:59:59
          required: false
          schema:
            type: string
            description: The end date for trial links. Keep empty to get all. Must not be
              greater than 255 characters.
            example: 2025-01-31 23:59:59
            nullable: true
        - in: query
          name: limit
          description: The number of trial links to return. Default `10`. Must be at least
            1. Must not be greater than 100.
          example: 10
          required: false
          schema:
            type: integer
            description: The number of trial links to return. Default `10`. Must be at least
              1. Must not be greater than 100.
            example: 10
        - in: query
          name: offset
          description: The offset used for pagination. Default `0`. Must be at least 0.
          example: 0
          required: false
          schema:
            type: integer
            description: The offset used for pagination. Default `0`. Must be at least 0.
            example: 0
        - in: query
          name: sort
          description: Sort direction. Default `desc`.
          example: desc
          required: false
          schema:
            type: string
            description: Sort direction. Default `desc`.
            example: desc
            enum:
              - asc
              - desc
        - in: query
          name: field
          description: Field to sort by. Default `create_date`.
          example: create_date
          required: false
          schema:
            type: string
            description: Field to sort by. Default `create_date`.
            example: create_date
            enum:
              - create_date
              - expire_date
              - subscribe_counts
              - subscribe_days
              - claims_count
        - in: query
          name: synchronous
          description: Wait for revenue calculation instead of processing it in the
            background.
          example: false
          required: false
          schema:
            type: boolean
            description: Wait for revenue calculation instead of processing it in the
              background.
            example: false
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - id: 123
                        trialLinkName: Trial link name
                        url: https://onlyfans.com/username/trial/abc123
                        subscribeDays: 30
                        subscribeCounts: 0
                        claimCounts: 123
                        clicksCounts: 182
                        expiredAt: null
                        createdAt: 2025-01-01T01:01:01+00:00
                        isFinished: false
                        tags:
                          - Instagram
                          - Twitter
                        revenue:
                          total: 123
                          revenuePerSubscriber: 12
                          spendersCount: 16
                          calculatedAt: 2025-01-01T01:01:01+00:00
                          isLoading: false
                        links:
                          related:
                            subscribers: https://app.onlyfansapi.com/api/acct_abc123/trial-links/123/subscribers
                    hasMore: true
                  _pagination:
                    next_page: https://app.onlyfansapi.com/api/acct_abc123/trial-links?limit=10&offset=10
                  _meta:
                    _credits:
                      used: 1
                      balance: 115580
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 997
                      remaining_day: 49990
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - id: 123
                            trialLinkName: Trial link name
                            url: https://onlyfans.com/username/trial/abc123
                            subscribeDays: 30
                            subscribeCounts: 0
                            claimCounts: 123
                            clicksCounts: 182
                            expiredAt: null
                            createdAt: 2025-01-01T01:01:01+00:00
                            isFinished: false
                            tags:
                              - Instagram
                              - Twitter
                            revenue:
                              total: 123
                              revenuePerSubscriber: 12
                              spendersCount: 16
                              calculatedAt: 2025-01-01T01:01:01+00:00
                              isLoading: false
                            links:
                              related:
                                subscribers: https://app.onlyfansapi.com/api/acct_abc123/trial-links/123/subscribers
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            trialLinkName:
                              type: string
                              example: Trial link name
                            url:
                              type: string
                              example: https://onlyfans.com/username/trial/abc123
                            subscribeDays:
                              type: integer
                              example: 30
                            subscribeCounts:
                              type: integer
                              example: 0
                            claimCounts:
                              type: integer
                              example: 123
                            clicksCounts:
                              type: integer
                              example: 182
                            expiredAt:
                              type: string
                              example: null
                              nullable: true
                            createdAt:
                              type: string
                              example: 2025-01-01T01:01:01+00:00
                            isFinished:
                              type: boolean
                              example: false
                            tags:
                              type: array
                              example:
                                - Instagram
                                - Twitter
                              items:
                                type: string
                            revenue:
                              type: object
                              properties:
                                total:
                                  type: number
                                  example: 123
                                revenuePerSubscriber:
                                  type: number
                                  example: 12
                                spendersCount:
                                  type: integer
                                  example: 16
                                calculatedAt:
                                  type: string
                                  example: 2025-01-01T01:01:01+00:00
                                isLoading:
                                  type: boolean
                                  example: false
                            links:
                              type: object
                              properties:
                                related:
                                  type: object
                                  properties:
                                    subscribers:
                                      type: string
                                      example: https://app.onlyfansapi.com/api/acct_abc123/trial-links/123/subscribers
                      hasMore:
                        type: boolean
                        example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: https://app.onlyfansapi.com/api/acct_abc123/trial-links?limit=10&offset=10
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 115580
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 49990
      tags:
        - Free Trial Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Remove Free Trial Link Tags (/api-reference/free-trial-links/remove-free-trial-link-tags)

Remove tags from a specific free trial link. This is a free endpoint.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/trial-links/{trial_link_id}/tags
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/trial-links/{trial_link_id}/tags:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: trial_link_id
        description: The ID of the trial link
        example: 123456789
        required: true
        schema:
          type: integer
    delete:
      summary: Remove Free Trial Link Tags
      operationId: removeFreeTrialLinkTags
      description: Remove tags from a specific free trial link. This is a free endpoint.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    tags:
                      - Twitter
                  _meta:
                    _credits:
                      used: 0
                      balance: 9529
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                properties:
                  data:
                    type: object
                    properties:
                      tags:
                        type: array
                        example:
                          - Twitter
                        items:
                          type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9529
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
      tags:
        - Free Trial Links
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tags:
                  type: array
                  description: Array of tag names to remove from the trial link.
                  example: '["Instagram"]'
                  items:
                    type: string
              required:
                - tags
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Mass Message Overview (/api-reference/mass-messaging/get-mass-message-overview)

Get an overview of mass messages, showing the send count and view count.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/mass-messaging/overview
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/mass-messaging/overview:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Mass Message Overview
      operationId: getMassMessageOverview
      description: Get an overview of mass messages, showing the send count and view count.
      parameters:
        - in: query
          name: startDate
          description: The earliest mass message to retrieve. Keep empty to get all.
          example: 2025-01-01 00:00:00
          required: false
          schema:
            type: string
            description: The earliest mass message to retrieve. Keep empty to get all.
            example: 2025-01-01 00:00:00
        - in: query
          name: endDate
          description: The latest mass message to retrieve. Keep empty to get all. It must
            be after `startDate` and is also used for pagination.
          example: 2025-03-31 23:59:59
          required: false
          schema:
            type: string
            description: The latest mass message to retrieve. Keep empty to get all. It must
              be after `startDate` and is also used for pagination.
            example: 2025-03-31 23:59:59
        - in: query
          name: limit
          description: Number of mass messages to return (default = 10)
          example: 10
          required: false
          schema:
            type: integer
            description: Number of mass messages to return (default = 10)
            example: 10
        - in: query
          name: query
          description: Optionally, find a mass message by the message text.
          example: My message text
          required: false
          schema:
            type: string
            description: Optionally, find a mass message by the message text.
            example: My message text
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    hasMore: true
                    items:
                      - id: 123
                        date: 2025-01-01T01:01:01+01:01
                        responseType: message
                        text: <p>Text</p>
                        rawText: <p>Text</p>
                        giphyId: null
                        isFree: true
                        isMediaReady: true
                        mediaCount: 1
                        media:
                          - id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: 2025-01-01T01:01:01+01:01
                            isReady: true
                            files:
                              full:
                                url: https://cdn2.onlyfans.com/files/.../image.jpg
                                width: 2335
                                height: 4175
                                size: 0
                                sources: []
                              thumb:
                                url: https://cdn2.onlyfans.com/files/.../image.jpg
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: https://cdn2.onlyfans.com/files/.../image.jpg
                                width: 960
                                height: 1717
                                size: 0
                              squarePreview:
                                url: https://cdn2.onlyfans.com/files/.../image.jpg
                                width: 960
                                height: 960
                                size: 0
                            duration: 0
                            hasCustomPreview: false
                            videoSources:
                              "240": null
                              "720": null
                        previews: []
                        isTip: false
                        isReportedByMe: false
                        viewedCount: 123
                        sentCount: 123
                        isCanceled: false
                        template: group
                        canUnsend: true
                        unsendSeconds: 1000000
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999959
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49988
                properties:
                  data:
                    type: object
                    properties:
                      hasMore:
                        type: boolean
                        example: true
                      items:
                        type: array
                        example:
                          - id: 123
                            date: 2025-01-01T01:01:01+01:01
                            responseType: message
                            text: <p>Text</p>
                            rawText: <p>Text</p>
                            giphyId: null
                            isFree: true
                            isMediaReady: true
                            mediaCount: 1
                            media:
                              - id: 123
                                type: photo
                                convertedToVideo: false
                                canView: true
                                hasError: false
                                createdAt: 2025-01-01T01:01:01+01:01
                                isReady: true
                                files:
                                  full:
                                    url: https://cdn2.onlyfans.com/files/.../image.jpg
                                    width: 2335
                                    height: 4175
                                    size: 0
                                    sources: []
                                  thumb:
                                    url: https://cdn2.onlyfans.com/files/.../image.jpg
                                    width: 300
                                    height: 300
                                    size: 0
                                  preview:
                                    url: https://cdn2.onlyfans.com/files/.../image.jpg
                                    width: 960
                                    height: 1717
                                    size: 0
                                  squarePreview:
                                    url: https://cdn2.onlyfans.com/files/.../image.jpg
                                    width: 960
                                    height: 960
                                    size: 0
                                duration: 0
                                hasCustomPreview: false
                                videoSources:
                                  "240": null
                                  "720": null
                            previews: []
                            isTip: false
                            isReportedByMe: false
                            viewedCount: 123
                            sentCount: 123
                            isCanceled: false
                            template: group
                            canUnsend: true
                            unsendSeconds: 1000000
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            date:
                              type: string
                              example: 2025-01-01T01:01:01+01:01
                            responseType:
                              type: string
                              example: message
                            text:
                              type: string
                              example: <p>Text</p>
                            rawText:
                              type: string
                              example: <p>Text</p>
                            giphyId:
                              type: string
                              example: null
                              nullable: true
                            isFree:
                              type: boolean
                              example: true
                            isMediaReady:
                              type: boolean
                              example: true
                            mediaCount:
                              type: integer
                              example: 1
                            media:
                              type: array
                              example:
                                - id: 123
                                  type: photo
                                  convertedToVideo: false
                                  canView: true
                                  hasError: false
                                  createdAt: 2025-01-01T01:01:01+01:01
                                  isReady: true
                                  files:
                                    full:
                                      url: https://cdn2.onlyfans.com/files/.../image.jpg
                                      width: 2335
                                      height: 4175
                                      size: 0
                                      sources: []
                                    thumb:
                                      url: https://cdn2.onlyfans.com/files/.../image.jpg
                                      width: 300
                                      height: 300
                                      size: 0
                                    preview:
                                      url: https://cdn2.onlyfans.com/files/.../image.jpg
                                      width: 960
                                      height: 1717
                                      size: 0
                                    squarePreview:
                                      url: https://cdn2.onlyfans.com/files/.../image.jpg
                                      width: 960
                                      height: 960
                                      size: 0
                                  duration: 0
                                  hasCustomPreview: false
                                  videoSources:
                                    "240": null
                                    "720": null
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  type:
                                    type: string
                                    example: photo
                                  convertedToVideo:
                                    type: boolean
                                    example: false
                                  canView:
                                    type: boolean
                                    example: true
                                  hasError:
                                    type: boolean
                                    example: false
                                  createdAt:
                                    type: string
                                    example: 2025-01-01T01:01:01+01:01
                                  isReady:
                                    type: boolean
                                    example: true
                                  files:
                                    type: object
                                    properties:
                                      full:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                            example: https://cdn2.onlyfans.com/files/.../image.jpg
                                          width:
                                            type: integer
                                            example: 2335
                                          height:
                                            type: integer
                                            example: 4175
                                          size:
                                            type: integer
                                            example: 0
                                          sources:
                                            type: array
                                            example: []
                                      thumb:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                            example: https://cdn2.onlyfans.com/files/.../image.jpg
                                          width:
                                            type: integer
                                            example: 300
                                          height:
                                            type: integer
                                            example: 300
                                          size:
                                            type: integer
                                            example: 0
                                      preview:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                            example: https://cdn2.onlyfans.com/files/.../image.jpg
                                          width:
                                            type: integer
                                            example: 960
                                          height:
                                            type: integer
                                            example: 1717
                                          size:
                                            type: integer
                                            example: 0
                                      squarePreview:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                            example: https://cdn2.onlyfans.com/files/.../image.jpg
                                          width:
                                            type: integer
                                            example: 960
                                          height:
                                            type: integer
                                            example: 960
                                          size:
                                            type: integer
                                            example: 0
                                  duration:
                                    type: integer
                                    example: 0
                                  hasCustomPreview:
                                    type: boolean
                                    example: false
                                  videoSources:
                                    type: object
                                    properties:
                                      "240":
                                        type: string
                                        example: null
                                        nullable: true
                                      "720":
                                        type: string
                                        example: null
                                        nullable: true
                            previews:
                              type: array
                              example: []
                            isTip:
                              type: boolean
                              example: false
                            isReportedByMe:
                              type: boolean
                              example: false
                            viewedCount:
                              type: integer
                              example: 123
                            sentCount:
                              type: integer
                              example: 123
                            isCanceled:
                              type: boolean
                              example: false
                            template:
                              type: string
                              example: group
                            canUnsend:
                              type: boolean
                              example: true
                            unsendSeconds:
                              type: integer
                              example: 1000000
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999959
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49988
      tags:
        - Mass Messaging
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Mass Message (/api-reference/mass-messaging/get-mass-message)

Get the content of a mass message.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/mass-messaging/{id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/mass-messaging/{id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: id
        description: The ID of the message queue item. Can be retrieved from the above
          store and list endpoints.
        example: 1234567890
        required: true
        schema:
          type: string
    get:
      summary: Get Mass Message
      operationId: getMassMessage
      description: Get the content of a mass message.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                    queue:
                      id: 123
                      date: 2025-01-01T01:01:01+00:00
                      text: My message
                      giphyId: null
                      textCropped: My message
                      isFree: true
                      sentCount: 2
                      viewedCount: 0
                      canUnsend: false
                      unsendSeconds: 0
                      isCanceled: true
                      mediaTypes: null
                      hasError: false
                      releaseForms: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 955
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 994
                      remaining_day: 49980
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                      queue:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 123
                          date:
                            type: string
                            example: 2025-01-01T01:01:01+00:00
                          text:
                            type: string
                            example: My message
                          giphyId:
                            type: string
                            example: null
                            nullable: true
                          textCropped:
                            type: string
                            example: My message
                          isFree:
                            type: boolean
                            example: true
                          sentCount:
                            type: integer
                            example: 2
                          viewedCount:
                            type: integer
                            example: 0
                          canUnsend:
                            type: boolean
                            example: false
                          unsendSeconds:
                            type: integer
                            example: 0
                          isCanceled:
                            type: boolean
                            example: true
                          mediaTypes:
                            type: string
                            example: null
                            nullable: true
                          hasError:
                            type: boolean
                            example: false
                          releaseForms:
                            type: array
                            example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 955
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 994
                          remaining_day:
                            type: integer
                            example: 49980
      tags:
        - Mass Messaging
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Mass Message Queue (/api-reference/mass-messaging/list-mass-message-queue)

List the pending or recently sent mass messages in the message queue.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/mass-messaging
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/mass-messaging:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Mass Message Queue
      operationId: listMassMessageQueue
      description: List the pending or recently sent mass messages in the message queue.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - id: 123
                      date: 2025-01-01T01:01:01+00:00
                      isReady: true
                      isDone: false
                      total: -1
                      pending: 2
                      canUnsend: true
                      unsendSeconds: 1000000
                      hasError: false
                      isCanceled: false
                      isCouplePeopleMedia: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 964
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 997
                      remaining_day: 49989
                properties:
                  data:
                    type: array
                    example:
                      - id: 123
                        date: 2025-01-01T01:01:01+00:00
                        isReady: true
                        isDone: false
                        total: -1
                        pending: 2
                        canUnsend: true
                        unsendSeconds: 1000000
                        hasError: false
                        isCanceled: false
                        isCouplePeopleMedia: false
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 123
                        date:
                          type: string
                          example: 2025-01-01T01:01:01+00:00
                        isReady:
                          type: boolean
                          example: true
                        isDone:
                          type: boolean
                          example: false
                        total:
                          type: integer
                          example: -1
                        pending:
                          type: integer
                          example: 2
                        canUnsend:
                          type: boolean
                          example: true
                        unsendSeconds:
                          type: integer
                          example: 1000000
                        hasError:
                          type: boolean
                          example: false
                        isCanceled:
                          type: boolean
                          example: false
                        isCouplePeopleMedia:
                          type: boolean
                          example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 964
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 49989
      tags:
        - Mass Messaging
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Send Mass Message (/api-reference/mass-messaging/send-mass-message)

Send a mass message to lists and/or users. You may use both the `userLists` and `userIds` parameters to send the same message to both lists and individual users.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/mass-messaging
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/mass-messaging:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Send Mass Message
      operationId: sendMassMessage
      description: Send a mass message to lists and/or users. You may use both the
        `userLists` and `userIds` parameters to send the same message to both
        lists and individual users.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    date: 2025-01-01T01:01:01+00:00
                    isReady: true
                    isDone: false
                    total: -1
                    pending: 0
                    canUnsend: true
                    unsendSeconds: 1000000
                    hasError: false
                    isCanceled: false
                    isCouplePeopleMedia: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 967
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49992
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      date:
                        type: string
                        example: 2025-01-01T01:01:01+00:00
                      isReady:
                        type: boolean
                        example: true
                      isDone:
                        type: boolean
                        example: false
                      total:
                        type: integer
                        example: -1
                      pending:
                        type: integer
                        example: 0
                      canUnsend:
                        type: boolean
                        example: true
                      unsendSeconds:
                        type: integer
                        example: 1000000
                      hasError:
                        type: boolean
                        example: false
                      isCanceled:
                        type: boolean
                        example: false
                      isCouplePeopleMedia:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 967
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49992
      tags:
        - Mass Messaging
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                userLists:
                  type: array
                  description: Array of user list IDs that the mass message will be sent to.
                  example:
                    - fans
                    - recent
                    - following
                    - rebill_off
                    - tagged
                    - 1234567890
                  items:
                    type: string
                excludedLists:
                  type: array
                  description: Array of user list IDs that the mass message will NOT be sent to.
                  example:
                    - fans
                    - recent
                    - following
                    - rebill_off
                    - tagged
                    - 1234567890
                  items:
                    type: string
                userIds:
                  type: array
                  description: Array of user IDs that the mass message will be sent to.
                  example:
                    - 1234567890
                  items:
                    type: string
                text:
                  type: string
                  description: The message text content
                  example: Hello!
                lockedText:
                  type: boolean
                  description: Whether the text should be shown or hidden
                  example: true
                price:
                  type: integer
                  description: Price for paid content (0 or between 3-200). In case this is not
                    zero, **mediaFiles** is required
                  example: 100
                mediaFiles:
                  type: array
                  description: Direct file uploads, OFAPI `ofapi_media_` IDs, or OF vault IDs.
                    Will be hidden if `price` is provided.
                  example:
                    - ofapi_media_abc123
                    - 1234567890
                  items:
                    type: file[]|string
                previews:
                  type: array
                  description: Direct file uploads, OFAPI `ofapi_media_` IDs, OF vault IDs, or
                    integer indices referencing uploaded files in `mediaFiles`.
                    Will be shown if `price` is provided.
                  example:
                    - ofapi_media_abc123
                    - 1234567890
                  items:
                    type: file[]|string[]|int
                giphyId:
                  type: string
                  description: The ID of the Giphy GIF to attach to the message. Get IDs from the
                    Giphy listing endpoints (`/giphy/trending`,
                    `/giphy/search`).
                  example: WAGC3LeqJvXglm5H7a
                rfTag:
                  type: string
                  description: Array of OnlyFans Creator User IDs to tag in your mass message
                  example: null
                rfPartner:
                  type: string
                  description: Array of OnlyFans Release Form Partners IDs to tag in your mass
                    message
                  example: null
                rfGuest:
                  type: string
                  description: Array of OnlyFans Release Form Guest IDs to tag in your mass
                    message
                  example: null
                scheduledDate:
                  type: string
                  description: Schedule the chat message in the future (UTC timezone).
                  example: 2025-01-01T00:00:00.000Z
                saveForLater:
                  type: boolean
                  description: Add your message to the "Saved for later" queue.
                  example: true
                blockBannedWords:
                  type: string
                  description: Screen `text` for OnlyFans banned words and block the send if any
                    are found (returns a 422 listing the offending words).
                    `strict_ban` blocks all tiers, `risky` blocks Risky +
                    Replace/soften, `replace_soften` blocks Replace/soften only.
                    Omit to disable screening.
                  example: strict_ban
                  enum:
                    - strict_ban
                    - risky
                    - replace_soften
              required:
                - text
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Unsend/Delete Mass Message (/api-reference/mass-messaging/unsend-delete-mass-message)

Unsend a recently sent mass message, or delete a scheduled/saved message. When unsending, purchased content will continue to be able to viewable.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/mass-messaging/{id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/mass-messaging/{id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: id
        description: The ID of the message queue item. Can be retrieved from the above
          store and list endpoints.
        example: 1234567890
        required: true
        schema:
          type: string
    delete:
      summary: Unsend/Delete Mass Message
      operationId: unsendDeleteMassMessage
      description: Unsend a recently sent mass message, or delete a scheduled/saved
        message. When unsending, purchased content will continue to be able to
        viewable.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                    queue:
                      id: 123
                      date: 2025-01-01T01:01:01+00:00
                      text: My message
                      giphyId: null
                      textCropped: My message
                      isFree: true
                      sentCount: 2
                      viewedCount: 0
                      canUnsend: false
                      unsendSeconds: 0
                      isCanceled: true
                      mediaTypes: null
                      hasError: false
                      releaseForms: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 955
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 994
                      remaining_day: 49980
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                      queue:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 123
                          date:
                            type: string
                            example: 2025-01-01T01:01:01+00:00
                          text:
                            type: string
                            example: My message
                          giphyId:
                            type: string
                            example: null
                            nullable: true
                          textCropped:
                            type: string
                            example: My message
                          isFree:
                            type: boolean
                            example: true
                          sentCount:
                            type: integer
                            example: 2
                          viewedCount:
                            type: integer
                            example: 0
                          canUnsend:
                            type: boolean
                            example: false
                          unsendSeconds:
                            type: integer
                            example: 0
                          isCanceled:
                            type: boolean
                            example: true
                          mediaTypes:
                            type: string
                            example: null
                            nullable: true
                          hasError:
                            type: boolean
                            example: false
                          releaseForms:
                            type: array
                            example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 955
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 994
                          remaining_day:
                            type: integer
                            example: 49980
      tags:
        - Mass Messaging
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Update Mass Message (/api-reference/mass-messaging/update-mass-message)

Update a mass message.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml put /api/{account}/mass-messaging/{id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/mass-messaging/{id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: id
        description: The ID of the message queue item. Can be retrieved from the above
          store and list endpoints.
        example: 1234567890
        required: true
        schema:
          type: string
    put:
      summary: Update Mass Message
      operationId: updateMassMessage
      description: Update a mass message.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    date: 2025-01-01T01:01:01+01:01
                    isReady: true
                    isDone: false
                    total: -1
                    pending: 0
                    canUnsend: true
                    unsendSeconds: 1000000
                    hasError: false
                    isCanceled: false
                    isCouplePeopleMedia: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999919
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49942
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      date:
                        type: string
                        example: 2025-01-01T01:01:01+01:01
                      isReady:
                        type: boolean
                        example: true
                      isDone:
                        type: boolean
                        example: false
                      total:
                        type: integer
                        example: -1
                      pending:
                        type: integer
                        example: 0
                      canUnsend:
                        type: boolean
                        example: true
                      unsendSeconds:
                        type: integer
                        example: 1000000
                      hasError:
                        type: boolean
                        example: false
                      isCanceled:
                        type: boolean
                        example: false
                      isCouplePeopleMedia:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999919
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49942
      tags:
        - Mass Messaging
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                userLists:
                  type: array
                  description: Array of user list IDs that the mass message will be sent to.
                  example:
                    - fans
                    - recent
                    - following
                    - rebill_off
                    - tagged
                    - 1234567890
                  items:
                    type: string
                userIds:
                  type: array
                  description: Array of user IDs that the mass message will be sent to.
                  example:
                    - 1234567890
                  items:
                    type: string
                text:
                  type: string
                  description: The message text content
                  example: Hello!
                lockedText:
                  type: boolean
                  description: Whether the text should be shown or hidden
                  example: true
                price:
                  type: integer
                  description: Price for paid content (0 or between 3-200). In case this is not
                    zero, **mediaFiles** is required
                  example: 100
                mediaFiles:
                  type: array
                  description: Array of media file upload prefixed_ids, or OF media IDs (required
                    if price is not 0). Will be hidden if `price` is provided.
                  example:
                    - ofapi_media_abc123
                    - 1234567890
                  items:
                    type: string
                previews:
                  type: array
                  description: Array of media file upload prefixed_ids, or OF media IDs (required
                    if price is not 0). Will be shown if `price` is provided.
                    All `previews` values must also exist in the `mediaFiles`
                    array.
                  example:
                    - ofapi_media_abc123
                    - 1234567890
                  items:
                    type: string
                giphyId:
                  type: string
                  description: The ID of the Giphy GIF to attach to the message. Get IDs from the
                    Giphy listing endpoints (`/giphy/trending`,
                    `/giphy/search`).
                  example: WAGC3LeqJvXglm5H7a
                scheduledDate:
                  type: string
                  description: Schedule the chat message in the future (UTC timezone).
                  example: 2025-01-01T00:00:00.000Z
                blockBannedWords:
                  type: string
                  description: Screen `text` for OnlyFans banned words and block the update if any
                    are found (returns a 422 listing the offending words).
                    `strict_ban` blocks all tiers, `risky` blocks Risky +
                    Replace/soften, `replace_soften` blocks Replace/soften only.
                    Omit to disable screening.
                  example: strict_ban
                  enum:
                    - strict_ban
                    - risky
                    - replace_soften
              required:
                - text
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# [Deprecated] Scrape media from the OnlyFans CDN (/api-reference/media/deprecated-scrape-media-from-the-only-fans-cdn)

**⚠️ This is a deprecated endpoint. Please use the new "Download media from the OnlyFans CDN" endpoint!** Scrapes a `https://cdn*.onlyfans.com/*` URL *or* Vault Media ID, and uploads it to the OnlyFans API CDN, where you can view or download the file. **Max file size is 500MB**

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/media/scrape
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/media/scrape:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: "[Deprecated] Scrape media from the OnlyFans CDN"
      operationId: DeprecatedScrapeMediaFromTheOnlyFansCDN
      description: '**⚠️ This is a deprecated endpoint. Please use the new "Download
        media from the OnlyFans CDN" endpoint!** Scrapes a
        `https://cdn*.onlyfans.com/*` URL *or* Vault Media ID, and uploads it to
        the OnlyFans API CDN, where you can view or download the file. **Max
        file size is 500MB**'
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  temporary_url: https://ofapi-media-prod.nyc3.digitaloceanspaces.com/123/600x400_123.jpg
                  expiration_date: 2025-01-01T00:00:00.000000Z
                properties:
                  temporary_url:
                    type: string
                    example: https://ofapi-media-prod.nyc3.digitaloceanspaces.com/123/600x400_123.jpg
                  expiration_date:
                    type: string
                    example: 2025-01-01T00:00:00.000000Z
        "500":
          description: The provided CDN URL is expired, invalid, or the file is not
            available anymore.
          content:
            application/json:
              schema:
                type: object
                example:
                  error: ONLYFANS_COM_ERROR
                  message: "OnlyFans returned an unknown error.: [403]"
                  description: This error happened most probably because of a bug in the
                    OnlyFans.com API or you sent wrong parameters (like a
                    non-existing user id).
                  onlyfans_response:
                    status: 403
                    body: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 123
                      note: OnlyFans returned an error, but we still had to make an API request to
                        OnlyFans.com
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 50000
                properties:
                  error:
                    type: string
                    example: ONLYFANS_COM_ERROR
                  message:
                    type: string
                    example: "OnlyFans returned an unknown error.: [403]"
                  description:
                    type: string
                    example: This error happened most probably because of a bug in the OnlyFans.com
                      API or you sent wrong parameters (like a non-existing user
                      id).
                  onlyfans_response:
                    type: object
                    properties:
                      status:
                        type: integer
                        example: 403
                      body:
                        type: string
                        example: null
                        nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 123
                          note:
                            type: string
                            example: OnlyFans returned an error, but we still had to make an API request to
                              OnlyFans.com
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 50000
      tags:
        - Media
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: The CDN URL to scrape. **Keep in mind that these URLs expire
                    fast.**
                  example: https://cdn2.onlyfans.com/files/e/e5/123/600x400_123.jpg?Tag=2&u=123&Policy=123&Signature=signature&Key-Pair-Id=123
                  nullable: true
                media_id:
                  type: integer
                  description: The OnlyFans Vault Media ID. **Can be used instead of the `url`.**
                  example: 1234567890
                  nullable: true
                file_type:
                  type: string
                  description: The file type to scrape. Only allowed when using `media_id`.
                  example: full
                  enum:
                    - full
                    - thumb
                    - preview
                    - squarePreview
                  nullable: true
                expiration_date:
                  type: string
                  description: The expiration date of our returned `temporary_url`. Default of 5
                    minutes. Must be null if `public` is true.
                  example: 2025-01-01 00:00:00
                  nullable: true
                public:
                  type: boolean
                  description: Set to true if you want to have the file uploaded to our public CDN
                    (no signed URL needed to access). Default is false. Must be
                    null if `expiration_date` is set.
                  example: false
                  nullable: true
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Download Media from the OnlyFans CDN (/api-reference/media/download-media-from-the-only-fans-cdn)

Downloads a file directly from a `https://cdn*.onlyfans.com/*` URL. When the file is already cached on our CDN, this endpoint returns a `302` redirect to a `https://cdn.fansapi.com/*` URL. Most HTTP clients follow redirects automatically (`curl` requires `-L`). Otherwise, the file is redirected to `dl.fansapi.com`, which streams it through the account proxy and reports billing back to the API.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/media/download/{cdnUrl}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/media/download/{cdnUrl}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: cdnUrl
        description: Optional parameter. The CDN URL to scrape. **Keep in mind that
          these URLs expire in approx. 20 minutes.** So for example, if you
          fetched Media Vault Items at 01:00pm, the URLs will expire at around
          01:20pm
        required: true
        schema:
          type: string
        examples:
          omitted:
            summary: When the value is omitted
            value: ""
          present:
            summary: When the value is present
            value: https://cdn2.onlyfans.com/files/e/e5/123/600x400_123.jpg?Tag=2&u=123&Policy=123&Signature=signature&Key-Pair-Id=123
    get:
      summary: Download Media from the OnlyFans CDN
      operationId: downloadMediaFromTheOnlyFansCDN
      description: Downloads a file directly from a `https://cdn*.onlyfans.com/*` URL.
        When the file is already cached on our CDN, this endpoint returns a
        `302` redirect to a `https://cdn.fansapi.com/*` URL. Most HTTP clients
        follow redirects automatically (`curl` requires `-L`). Otherwise, the
        file is redirected to `dl.fansapi.com`, which streams it through the
        account proxy and reports billing back to the API.
      parameters: []
      responses:
        "302":
          description: ""
          content:
            text/plain:
              schema:
                type: string
                example: <Redirect to the download service or cached CDN file>
        "401":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  error: Unauthorized. Go to https://app.onlyfansapi.com/api-keys to get your API
                    key.
                properties:
                  error:
                    type: string
                    example: Unauthorized. Go to https://app.onlyfansapi.com/api-keys to get your
                      API key.
      tags:
        - Media
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Upload Status (/api-reference/media/get-upload-status)

Check the status of a media upload. Poll this endpoint until status is `completed` or `failed`. This endpoint is free and does not cost any credits.

**Possible statuses:**

* `pending` — Upload is queued
* `processing` — Download/upload in progress
* `completed` — Upload finished, `media` and `credits_used` are included
* `failed` — Upload failed, `error` is included

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/media/uploads/{upload}/status
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/media/uploads/{upload}/status:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: upload
        description: The prefixed ID of the upload.
        example: ofapi_media_01JR1234
        required: true
        schema:
          type: string
    get:
      summary: Get Upload Status
      operationId: getUploadStatus
      description: >-
        Check the status of a media upload. Poll this endpoint until status is
        `completed` or `failed`. This endpoint is free and does not cost any
        credits.


        **Possible statuses:**

        - `pending` — Upload is queued

        - `processing` — Download/upload in progress

        - `completed` — Upload finished, `media` and `credits_used` are included

        - `failed` — Upload failed, `error` is included
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                oneOf:
                  - description: Upload still processing
                    type: object
                    example:
                      status: processing
                      prefixed_id: ofapi_media_01JR1234
                    properties:
                      status:
                        type: string
                        example: processing
                      prefixed_id:
                        type: string
                        example: ofapi_media_01JR1234
                  - description: Upload failed
                    type: object
                    example:
                      status: failed
                      prefixed_id: ofapi_media_01JR1234
                      error: Failed to download file from the provided URL.
                    properties:
                      status:
                        type: string
                        example: failed
                      prefixed_id:
                        type: string
                        example: ofapi_media_01JR1234
                      error:
                        type: string
                        example: Failed to download file from the provided URL.
                  - description: Completed POST /media/vault upload
                    type: object
                    example:
                      status: completed
                      prefixed_id: ofapi_media_abc123def456abc123def456abc123de
                      media:
                        id: 1234567890
                        type: photo
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: 2026-04-03T16:18:05+00:00
                        isReady: false
                        files:
                          full:
                            url: null
                            width: 0
                            height: 0
                            size: 0
                            sources: []
                          thumb: null
                          preview: null
                          squarePreview: null
                        duration: 0
                        releaseForms: []
                        hasCustomPreview: false
                      credits_used: 3
                    properties:
                      status:
                        type: string
                        example: completed
                      prefixed_id:
                        type: string
                        example: ofapi_media_abc123def456abc123def456abc123de
                      media:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1234567890
                          type:
                            type: string
                            example: photo
                          convertedToVideo:
                            type: boolean
                            example: false
                          canView:
                            type: boolean
                            example: true
                          hasError:
                            type: boolean
                            example: false
                          createdAt:
                            type: string
                            example: 2026-04-03T16:18:05+00:00
                          isReady:
                            type: boolean
                            example: false
                          files:
                            type: object
                            properties:
                              full:
                                type: object
                                properties:
                                  url:
                                    type: string
                                    example: null
                                    nullable: true
                                  width:
                                    type: integer
                                    example: 0
                                  height:
                                    type: integer
                                    example: 0
                                  size:
                                    type: integer
                                    example: 0
                                  sources:
                                    type: array
                                    example: []
                              thumb:
                                type: string
                                example: null
                                nullable: true
                              preview:
                                type: string
                                example: null
                                nullable: true
                              squarePreview:
                                type: string
                                example: null
                                nullable: true
                          duration:
                            type: integer
                            example: 0
                          releaseForms:
                            type: array
                            example: []
                          hasCustomPreview:
                            type: boolean
                            example: false
                      credits_used:
                        type: integer
                        example: 3
                  - description: Completed POST /media/upload upload
                    type: object
                    example:
                      status: completed
                      prefixed_id: ofapi_media_abc123def456abc123def456abc123de
                      media:
                        prefixed_id: ofapi_media_def456abc123def456abc123def456ab
                        file_name: photo.jpg
                        processId: abc123def456abc123de
                        host: convert3.onlyfans.com
                        sourceUrl: https://of2transcoder.s3.amazonaws.com/upload/00000000-0000-0000-0000-000000000000/000000000000/photo.jpg
                        extra: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx...
                        additional:
                          user: "123456789"
                        thumbs:
                          - id: 1
                            url: https://cdn2.onlyfans.com/files/0/00/00000000000000000000000000000000/300x544_00000000000000000000000000000000.jpg
                      credits_used: 3
                    properties:
                      status:
                        type: string
                        example: completed
                      prefixed_id:
                        type: string
                        example: ofapi_media_abc123def456abc123def456abc123de
                      media:
                        type: object
                        properties:
                          prefixed_id:
                            type: string
                            example: ofapi_media_def456abc123def456abc123def456ab
                          file_name:
                            type: string
                            example: photo.jpg
                          processId:
                            type: string
                            example: abc123def456abc123de
                          host:
                            type: string
                            example: convert3.onlyfans.com
                          sourceUrl:
                            type: string
                            example: https://of2transcoder.s3.amazonaws.com/upload/00000000-0000-0000-0000-000000000000/000000000000/photo.jpg
                          extra:
                            type: string
                            example: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx...
                          additional:
                            type: object
                            properties:
                              user:
                                type: string
                                example: "123456789"
                          thumbs:
                            type: array
                            example:
                              - id: 1
                                url: https://cdn2.onlyfans.com/files/0/00/00000000000000000000000000000000/300x544_00000000000000000000000000000000.jpg
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                url:
                                  type: string
                                  example: https://cdn2.onlyfans.com/files/0/00/00000000000000000000000000000000/300x544_00000000000000000000000000000000.jpg
                      credits_used:
                        type: integer
                        example: 3
      tags:
        - Media
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Upload media to the OnlyFans CDN (/api-reference/media/upload-media-to-the-only-fans-cdn)

The response can be used **only once** to manually include media in a post or message. This endpoint does not upload media to the Vault. You must provide either `file` or `file_url`.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/media/upload
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/media/upload:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Upload media to the OnlyFans CDN
      operationId: uploadMediaToTheOnlyFansCDN
      description: The response can be used **only once** to manually include media in
        a post or message. This endpoint does not upload media to the Vault. You
        must provide either `file` or `file_url`.
      parameters: []
      responses:
        "200":
          description: Synchronous upload (default)
          content:
            application/json:
              schema:
                type: object
                example:
                  prefixed_id: ofapi_media_abc123def456abc123def456abc123de
                  file_name: photo.jpg
                  processId: abc123def456abc123de
                  host: convert3.onlyfans.com
                  sourceUrl: https://of2transcoder.s3.amazonaws.com/upload/00000000-0000-0000-0000-000000000000/000000000000/photo.jpg
                  extra: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx...
                  additional:
                    user: "123456789"
                  thumbs:
                    - id: 1
                      url: https://cdn2.onlyfans.com/files/0/00/00000000000000000000000000000000/300x544_00000000000000000000000000000000.jpg
                  note: Maximum file size is 1 GB. Need higher limits? Contact us for enterprise
                    options.
                properties:
                  prefixed_id:
                    type: string
                    example: ofapi_media_abc123def456abc123def456abc123de
                  file_name:
                    type: string
                    example: photo.jpg
                  processId:
                    type: string
                    example: abc123def456abc123de
                  host:
                    type: string
                    example: convert3.onlyfans.com
                  sourceUrl:
                    type: string
                    example: https://of2transcoder.s3.amazonaws.com/upload/00000000-0000-0000-0000-000000000000/000000000000/photo.jpg
                  extra:
                    type: string
                    example: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx...
                  additional:
                    type: object
                    properties:
                      user:
                        type: string
                        example: "123456789"
                  thumbs:
                    type: array
                    example:
                      - id: 1
                        url: https://cdn2.onlyfans.com/files/0/00/00000000000000000000000000000000/300x544_00000000000000000000000000000000.jpg
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        url:
                          type: string
                          example: https://cdn2.onlyfans.com/files/0/00/00000000000000000000000000000000/300x544_00000000000000000000000000000000.jpg
                  note:
                    type: string
                    example: Maximum file size is 1 GB. Need higher limits? Contact us for
                      enterprise options.
        "202":
          description: Async upload (async=true)
          content:
            application/json:
              schema:
                type: object
                example:
                  status: pending
                  prefixed_id: ofapi_media_abc123def456abc123def456abc123de
                  polling_url: https://app.onlyfansapi.com/api/acct_abc123def456/media/uploads/ofapi_media_abc123def456abc123def456abc123de/status
                properties:
                  status:
                    type: string
                    example: pending
                  prefixed_id:
                    type: string
                    example: ofapi_media_abc123def456abc123def456abc123de
                  polling_url:
                    type: string
                    example: https://app.onlyfansapi.com/api/acct_abc123def456/media/uploads/ofapi_media_abc123def456abc123def456abc123de/status
      tags:
        - Media
      requestBody:
        required: false
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                  description: "The file to upload. Required if `file_url` is not provided.
                    Maximum file size: 100 MB (limited by Cloudflare)."
                file_url:
                  type: string
                  description: A URL to download the file from. Required if `file` is not
                    provided. Maximum file size depends on the subscription
                    configuration.
                  example: https://example.com/media/photo.jpg
                async:
                  type: boolean
                  description: Set to `true` to process uploads in the background. Returns a
                    `polling_url` to check status. Recommended for large files.
                  example: true
                type:
                  type: string
                  description: Set to `avatar` if this file will be used as a profile picture,
                    `header` for a profile banner, or keep empty if this file
                    will be for anything else.
                  example: avatar
                  enum:
                    - default
                    - avatar
                    - header
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Delete Vault Media (/api-reference/media-vault/delete-vault-media)

Delete one or multiple media from your vault.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/media/vault/delete-media
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/media/vault/delete-media:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    delete:
      summary: Delete Vault Media
      operationId: deleteVaultMedia
      description: Delete one or multiple media from your vault.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 981
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 996
                      remaining_day: 49926
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 981
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 996
                          remaining_day:
                            type: integer
                            example: 49926
      tags:
        - Media Vault
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                mediaIds:
                  type: array
                  description: Array of media IDs to delete.
                  example:
                    - 1234567890
                  items:
                    type: string
              required:
                - mediaIds
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Vault Media (/api-reference/media-vault/get-vault-media)

Retrieve details about a specific media item in your vault.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/media/vault/{media_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/media/vault/{media_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: media_id
        description: The ID of the media item to retrieve.
        example: 1234567890
        required: true
        schema:
          type: integer
    get:
      summary: Get Vault Media
      operationId: getVaultMedia
      description: Retrieve details about a specific media item in your vault.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 12345678
                    type: photo
                    convertedToVideo: false
                    canView: true
                    hasError: false
                    createdAt: 2025-01-01T00:00:00+00:00
                    isReady: true
                    files:
                      full:
                        url: https://cdn2.onlyfans.com/files/1/15/.../....jpg
                        width: 1280
                        height: 720
                        size: 0
                        sources: []
                      thumb:
                        url: https://cdn2.onlyfans.com/files/5/56/.../...jpg
                        width: 300
                        height: 300
                        size: 0
                      preview:
                        url: https://cdn2.onlyfans.com/files/7/76/.../...jpg
                        width: 960
                        height: 540
                        size: 0
                      squarePreview:
                        url: https://cdn2.onlyfans.com/files/4/48/.../...jpg
                        width: 960
                        height: 960
                        size: 0
                    duration: 0
                    hasPosts: false
                    listStates:
                      - id: 123
                        type: posts
                        name: Posts
                        hasMedia: true
                        canAddMedia: false
                      - id: 123
                        type: stories
                        name: Stories
                        hasMedia: false
                        canAddMedia: false
                      - id: 123
                        type: messages
                        name: Messages
                        hasMedia: false
                        canAddMedia: false
                      - id: 123
                        type: streams
                        name: Streams
                        hasMedia: false
                        canAddMedia: false
                      - id: 123
                        type: custom
                        name: Special posts
                        hasMedia: false
                        canAddMedia: true
                      - id: 123
                        type: media_stickers
                        name: Uploads
                        hasMedia: false
                        canAddMedia: false
                    hasCustomPreview: false
                    videoSources:
                      "240": null
                      "720": null
                  _meta:
                    _credits:
                      used: 1
                      balance: 563
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49991
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 12345678
                      type:
                        type: string
                        example: photo
                      convertedToVideo:
                        type: boolean
                        example: false
                      canView:
                        type: boolean
                        example: true
                      hasError:
                        type: boolean
                        example: false
                      createdAt:
                        type: string
                        example: 2025-01-01T00:00:00+00:00
                      isReady:
                        type: boolean
                        example: true
                      files:
                        type: object
                        properties:
                          full:
                            type: object
                            properties:
                              url:
                                type: string
                                example: https://cdn2.onlyfans.com/files/1/15/.../....jpg
                              width:
                                type: integer
                                example: 1280
                              height:
                                type: integer
                                example: 720
                              size:
                                type: integer
                                example: 0
                              sources:
                                type: array
                                example: []
                          thumb:
                            type: object
                            properties:
                              url:
                                type: string
                                example: https://cdn2.onlyfans.com/files/5/56/.../...jpg
                              width:
                                type: integer
                                example: 300
                              height:
                                type: integer
                                example: 300
                              size:
                                type: integer
                                example: 0
                          preview:
                            type: object
                            properties:
                              url:
                                type: string
                                example: https://cdn2.onlyfans.com/files/7/76/.../...jpg
                              width:
                                type: integer
                                example: 960
                              height:
                                type: integer
                                example: 540
                              size:
                                type: integer
                                example: 0
                          squarePreview:
                            type: object
                            properties:
                              url:
                                type: string
                                example: https://cdn2.onlyfans.com/files/4/48/.../...jpg
                              width:
                                type: integer
                                example: 960
                              height:
                                type: integer
                                example: 960
                              size:
                                type: integer
                                example: 0
                      duration:
                        type: integer
                        example: 0
                      hasPosts:
                        type: boolean
                        example: false
                      listStates:
                        type: array
                        example:
                          - id: 123
                            type: posts
                            name: Posts
                            hasMedia: true
                            canAddMedia: false
                          - id: 123
                            type: stories
                            name: Stories
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: messages
                            name: Messages
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: streams
                            name: Streams
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: custom
                            name: Special posts
                            hasMedia: false
                            canAddMedia: true
                          - id: 123
                            type: media_stickers
                            name: Uploads
                            hasMedia: false
                            canAddMedia: false
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            type:
                              type: string
                              example: posts
                            name:
                              type: string
                              example: Posts
                            hasMedia:
                              type: boolean
                              example: true
                            canAddMedia:
                              type: boolean
                              example: false
                      hasCustomPreview:
                        type: boolean
                        example: false
                      videoSources:
                        type: object
                        properties:
                          "240":
                            type: string
                            example: null
                            nullable: true
                          "720":
                            type: string
                            example: null
                            nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 563
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49991
      tags:
        - Media Vault
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Vault Media (/api-reference/media-vault/list-vault-media)

List media items stored in your vault. See how many likes and how much tips did they get.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/media/vault
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/media/vault:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Vault Media
      operationId: listVaultMedia
      description: List media items stored in your vault. See how many likes and how
        much tips did they get.
      parameters:
        - in: query
          name: query
          description: Optionally, search for a text query.
          example: Hi
          required: false
          schema:
            type: string
            description: Optionally, search for a text query.
            example: Hi
            nullable: true
        - in: query
          name: field
          description: Sort the results by a field. Default `recent`
          example: recent
          required: false
          schema:
            type: string
            description: Sort the results by a field. Default `recent`
            example: recent
            enum:
              - recent
              - most-liked
              - highest-tips
        - in: query
          name: type
          description: Filter the results by a media type. Keep empty to show all media.
          example: photo
          required: false
          schema:
            type: string
            description: Filter the results by a media type. Keep empty to show all media.
            example: photo
            enum:
              - photo
              - gif
              - video
              - audio
        - in: query
          name: list
          description: Only show media items from a specific list (category). **Refer to
            our Media Vault Lists endpoints.**
          example: "123456789"
          required: false
          schema:
            type: integer
            description: Only show media items from a specific list (category). **Refer to
              our Media Vault Lists endpoints.**
            example: "123456789"
        - in: query
          name: sort
          description: Sort the results. Default `desc`
          example: desc
          required: false
          schema:
            type: string
            description: Sort the results. Default `desc`
            example: desc
            enum:
              - desc
              - asc
        - in: query
          name: limit
          description: "Number of media to return per page (10 - 100). Default: `24`"
          example: 24
          required: false
          schema:
            type: integer
            description: "Number of media to return per page (10 - 100). Default: `24`"
            example: 24
        - in: query
          name: offset
          description: The offset used for pagination. Default `0`
          example: 0
          required: false
          schema:
            type: integer
            description: The offset used for pagination. Default `0`
            example: 0
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - id: 123
                        type: audio
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: 2025-01-01T00:00:00+00:00
                        isReady: true
                        counters:
                          likesCount: 0
                          tipsSumm: 0
                        files:
                          full:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 0
                            height: 0
                            size: 0
                            sources: []
                          thumb: null
                          preview: null
                          squarePreview: null
                        duration: 3
                        hasPosts: false
                        listStates:
                          - id: 123
                            type: posts
                            name: Posts
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: stories
                            name: Stories
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: messages
                            name: Messages
                            hasMedia: true
                            canAddMedia: false
                          - id: 123
                            type: streams
                            name: Streams
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: custom
                            name: custom category
                            hasMedia: false
                            canAddMedia: true
                          - id: 123
                            type: media_stickers
                            name: Uploads
                            hasMedia: false
                            canAddMedia: false
                        releaseForms: []
                        hasCustomPreview: false
                        videoSources:
                          "240": null
                          "720": null
                      - id: 123
                        type: audio
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: 2025-01-01T00:00:00+00:00
                        isReady: true
                        counters:
                          likesCount: 0
                          tipsSumm: 0
                        files:
                          full:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 0
                            height: 0
                            size: 0
                            sources: []
                          thumb: null
                          preview: null
                          squarePreview: null
                        duration: 3
                        hasPosts: false
                        listStates:
                          - id: 123
                            type: posts
                            name: Posts
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: stories
                            name: Stories
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: messages
                            name: Messages
                            hasMedia: true
                            canAddMedia: false
                          - id: 123
                            type: streams
                            name: Streams
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: custom
                            name: custom category
                            hasMedia: false
                            canAddMedia: true
                          - id: 123
                            type: media_stickers
                            name: Uploads
                            hasMedia: false
                            canAddMedia: false
                        releaseForms: []
                        hasCustomPreview: false
                        videoSources:
                          "240": null
                          "720": null
                      - id: 123
                        type: photo
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: 2025-01-01T00:00:00+00:00
                        isReady: true
                        counters:
                          likesCount: 0
                          tipsSumm: 0
                        files:
                          full:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 2048
                            height: 1360
                            size: 0
                            sources: []
                          thumb:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 300
                            height: 300
                            size: 0
                          preview:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 960
                            height: 638
                            size: 0
                          squarePreview:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 960
                            height: 960
                            size: 0
                        duration: 0
                        hasPosts: false
                        listStates:
                          - id: 123
                            type: posts
                            name: Posts
                            hasMedia: true
                            canAddMedia: false
                          - id: 123
                            type: stories
                            name: Stories
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: messages
                            name: Messages
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: streams
                            name: Streams
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: custom
                            name: custom category
                            hasMedia: false
                            canAddMedia: true
                          - id: 123
                            type: media_stickers
                            name: Uploads
                            hasMedia: false
                            canAddMedia: false
                        releaseForms: []
                        hasCustomPreview: false
                        videoSources:
                          "240": null
                          "720": null
                      - id: 123
                        type: photo
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: 2025-01-01T00:00:00+00:00
                        isReady: true
                        counters:
                          likesCount: 0
                          tipsSumm: 0
                        files:
                          full:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 2048
                            height: 1360
                            size: 0
                            sources: []
                          thumb:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 300
                            height: 300
                            size: 0
                          preview:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 960
                            height: 638
                            size: 0
                          squarePreview:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 960
                            height: 960
                            size: 0
                        duration: 0
                        hasPosts: false
                        listStates:
                          - id: 123
                            type: posts
                            name: Posts
                            hasMedia: true
                            canAddMedia: false
                          - id: 123
                            type: stories
                            name: Stories
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: messages
                            name: Messages
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: streams
                            name: Streams
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: custom
                            name: custom category
                            hasMedia: false
                            canAddMedia: true
                          - id: 123
                            type: media_stickers
                            name: Uploads
                            hasMedia: false
                            canAddMedia: false
                        releaseForms: []
                        hasCustomPreview: false
                        videoSources:
                          "240": null
                          "720": null
                      - id: 123
                        type: photo
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: 2025-01-01T00:00:00+00:00
                        isReady: true
                        counters:
                          likesCount: 0
                          tipsSumm: 0
                        files:
                          full:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 1629
                            height: 1629
                            size: 0
                            sources: []
                          thumb:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 300
                            height: 300
                            size: 0
                          preview:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 960
                            height: 960
                            size: 0
                          squarePreview:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 960
                            height: 960
                            size: 0
                        duration: 0
                        hasPosts: false
                        listStates:
                          - id: 123
                            type: posts
                            name: Posts
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: stories
                            name: Stories
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: messages
                            name: Messages
                            hasMedia: true
                            canAddMedia: false
                          - id: 123
                            type: streams
                            name: Streams
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: custom
                            name: custom category
                            hasMedia: false
                            canAddMedia: true
                          - id: 123
                            type: media_stickers
                            name: Uploads
                            hasMedia: false
                            canAddMedia: false
                        releaseForms: []
                        hasCustomPreview: false
                        videoSources:
                          "240": null
                          "720": null
                      - id: 123
                        type: photo
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: 2025-01-01T00:00:00+00:00
                        isReady: true
                        counters:
                          likesCount: 0
                          tipsSumm: 0
                        files:
                          full:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 1629
                            height: 1629
                            size: 0
                            sources: []
                          thumb:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 300
                            height: 300
                            size: 0
                          preview:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 960
                            height: 960
                            size: 0
                          squarePreview:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 960
                            height: 960
                            size: 0
                        duration: 0
                        hasPosts: false
                        listStates:
                          - id: 123
                            type: posts
                            name: Posts
                            hasMedia: true
                            canAddMedia: false
                          - id: 123
                            type: stories
                            name: Stories
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: messages
                            name: Messages
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: streams
                            name: Streams
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: custom
                            name: custom category
                            hasMedia: false
                            canAddMedia: true
                          - id: 123
                            type: media_stickers
                            name: Uploads
                            hasMedia: false
                            canAddMedia: false
                        releaseForms: []
                        hasCustomPreview: false
                        videoSources:
                          "240": null
                          "720": null
                      - id: 123
                        type: photo
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: 2025-01-01T00:00:00+00:00
                        isReady: true
                        counters:
                          likesCount: 0
                          tipsSumm: 0
                        files:
                          full:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 1629
                            height: 1629
                            size: 0
                            sources: []
                          thumb:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 300
                            height: 300
                            size: 0
                          preview:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 960
                            height: 960
                            size: 0
                          squarePreview:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 960
                            height: 960
                            size: 0
                        duration: 0
                        hasPosts: false
                        listStates:
                          - id: 123
                            type: posts
                            name: Posts
                            hasMedia: true
                            canAddMedia: false
                          - id: 123
                            type: stories
                            name: Stories
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: messages
                            name: Messages
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: streams
                            name: Streams
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: custom
                            name: custom category
                            hasMedia: false
                            canAddMedia: true
                          - id: 123
                            type: media_stickers
                            name: Uploads
                            hasMedia: false
                            canAddMedia: false
                        releaseForms: []
                        hasCustomPreview: false
                        videoSources:
                          "240": null
                          "720": null
                      - id: 123
                        type: photo
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: 2025-01-01T00:00:00+00:00
                        isReady: true
                        counters:
                          likesCount: 0
                          tipsSumm: 0
                        files:
                          full:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 1629
                            height: 1629
                            size: 0
                            sources: []
                          thumb:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 300
                            height: 300
                            size: 0
                          preview:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 960
                            height: 960
                            size: 0
                          squarePreview:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 960
                            height: 960
                            size: 0
                        duration: 0
                        hasPosts: false
                        listStates:
                          - id: 123
                            type: posts
                            name: Posts
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: stories
                            name: Stories
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: messages
                            name: Messages
                            hasMedia: true
                            canAddMedia: false
                          - id: 123
                            type: streams
                            name: Streams
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: custom
                            name: custom category
                            hasMedia: false
                            canAddMedia: true
                          - id: 123
                            type: media_stickers
                            name: Uploads
                            hasMedia: false
                            canAddMedia: false
                        releaseForms: []
                        hasCustomPreview: false
                        videoSources:
                          "240": null
                          "720": null
                      - id: 123
                        type: photo
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: 2025-01-01T00:00:00+00:00
                        isReady: true
                        counters:
                          likesCount: 0
                          tipsSumm: 0
                        files:
                          full:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 500
                            height: 500
                            size: 0
                            sources: []
                          thumb:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 300
                            height: 300
                            size: 0
                          preview:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 500
                            height: 500
                            size: 0
                          squarePreview:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 960
                            height: 960
                            size: 0
                        duration: 0
                        hasPosts: false
                        listStates:
                          - id: 123
                            type: posts
                            name: Posts
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: stories
                            name: Stories
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: messages
                            name: Messages
                            hasMedia: true
                            canAddMedia: false
                          - id: 123
                            type: streams
                            name: Streams
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: custom
                            name: custom category
                            hasMedia: false
                            canAddMedia: true
                          - id: 123
                            type: media_stickers
                            name: Uploads
                            hasMedia: false
                            canAddMedia: false
                        releaseForms: []
                        hasCustomPreview: false
                        videoSources:
                          "240": null
                          "720": null
                      - id: 123
                        type: photo
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: 2025-01-01T00:00:00+00:00
                        isReady: true
                        counters:
                          likesCount: 0
                          tipsSumm: 0
                        files:
                          full:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 1280
                            height: 720
                            size: 0
                            sources: []
                          thumb:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 300
                            height: 300
                            size: 0
                          preview:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 960
                            height: 540
                            size: 0
                          squarePreview:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 960
                            height: 960
                            size: 0
                        duration: 0
                        hasPosts: false
                        listStates:
                          - id: 123
                            type: posts
                            name: Posts
                            hasMedia: true
                            canAddMedia: false
                          - id: 123
                            type: stories
                            name: Stories
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: messages
                            name: Messages
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: streams
                            name: Streams
                            hasMedia: false
                            canAddMedia: false
                          - id: 123
                            type: custom
                            name: custom category
                            hasMedia: false
                            canAddMedia: true
                          - id: 123
                            type: media_stickers
                            name: Uploads
                            hasMedia: false
                            canAddMedia: false
                        releaseForms: []
                        hasCustomPreview: false
                        videoSources:
                          "240": null
                          "720": null
                    hasMore: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999960
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49989
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - id: 123
                            type: audio
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: 2025-01-01T00:00:00+00:00
                            isReady: true
                            counters:
                              likesCount: 0
                              tipsSumm: 0
                            files:
                              full:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 0
                                height: 0
                                size: 0
                                sources: []
                              thumb: null
                              preview: null
                              squarePreview: null
                            duration: 3
                            hasPosts: false
                            listStates:
                              - id: 123
                                type: posts
                                name: Posts
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: stories
                                name: Stories
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: messages
                                name: Messages
                                hasMedia: true
                                canAddMedia: false
                              - id: 123
                                type: streams
                                name: Streams
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: custom
                                name: custom category
                                hasMedia: false
                                canAddMedia: true
                              - id: 123
                                type: media_stickers
                                name: Uploads
                                hasMedia: false
                                canAddMedia: false
                            releaseForms: []
                            hasCustomPreview: false
                            videoSources:
                              "240": null
                              "720": null
                          - id: 123
                            type: audio
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: 2025-01-01T00:00:00+00:00
                            isReady: true
                            counters:
                              likesCount: 0
                              tipsSumm: 0
                            files:
                              full:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 0
                                height: 0
                                size: 0
                                sources: []
                              thumb: null
                              preview: null
                              squarePreview: null
                            duration: 3
                            hasPosts: false
                            listStates:
                              - id: 123
                                type: posts
                                name: Posts
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: stories
                                name: Stories
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: messages
                                name: Messages
                                hasMedia: true
                                canAddMedia: false
                              - id: 123
                                type: streams
                                name: Streams
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: custom
                                name: custom category
                                hasMedia: false
                                canAddMedia: true
                              - id: 123
                                type: media_stickers
                                name: Uploads
                                hasMedia: false
                                canAddMedia: false
                            releaseForms: []
                            hasCustomPreview: false
                            videoSources:
                              "240": null
                              "720": null
                          - id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: 2025-01-01T00:00:00+00:00
                            isReady: true
                            counters:
                              likesCount: 0
                              tipsSumm: 0
                            files:
                              full:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 2048
                                height: 1360
                                size: 0
                                sources: []
                              thumb:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 960
                                height: 638
                                size: 0
                              squarePreview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 960
                                height: 960
                                size: 0
                            duration: 0
                            hasPosts: false
                            listStates:
                              - id: 123
                                type: posts
                                name: Posts
                                hasMedia: true
                                canAddMedia: false
                              - id: 123
                                type: stories
                                name: Stories
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: messages
                                name: Messages
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: streams
                                name: Streams
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: custom
                                name: custom category
                                hasMedia: false
                                canAddMedia: true
                              - id: 123
                                type: media_stickers
                                name: Uploads
                                hasMedia: false
                                canAddMedia: false
                            releaseForms: []
                            hasCustomPreview: false
                            videoSources:
                              "240": null
                              "720": null
                          - id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: 2025-01-01T00:00:00+00:00
                            isReady: true
                            counters:
                              likesCount: 0
                              tipsSumm: 0
                            files:
                              full:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 2048
                                height: 1360
                                size: 0
                                sources: []
                              thumb:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 960
                                height: 638
                                size: 0
                              squarePreview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 960
                                height: 960
                                size: 0
                            duration: 0
                            hasPosts: false
                            listStates:
                              - id: 123
                                type: posts
                                name: Posts
                                hasMedia: true
                                canAddMedia: false
                              - id: 123
                                type: stories
                                name: Stories
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: messages
                                name: Messages
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: streams
                                name: Streams
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: custom
                                name: custom category
                                hasMedia: false
                                canAddMedia: true
                              - id: 123
                                type: media_stickers
                                name: Uploads
                                hasMedia: false
                                canAddMedia: false
                            releaseForms: []
                            hasCustomPreview: false
                            videoSources:
                              "240": null
                              "720": null
                          - id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: 2025-01-01T00:00:00+00:00
                            isReady: true
                            counters:
                              likesCount: 0
                              tipsSumm: 0
                            files:
                              full:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 1629
                                height: 1629
                                size: 0
                                sources: []
                              thumb:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 960
                                height: 960
                                size: 0
                              squarePreview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 960
                                height: 960
                                size: 0
                            duration: 0
                            hasPosts: false
                            listStates:
                              - id: 123
                                type: posts
                                name: Posts
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: stories
                                name: Stories
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: messages
                                name: Messages
                                hasMedia: true
                                canAddMedia: false
                              - id: 123
                                type: streams
                                name: Streams
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: custom
                                name: custom category
                                hasMedia: false
                                canAddMedia: true
                              - id: 123
                                type: media_stickers
                                name: Uploads
                                hasMedia: false
                                canAddMedia: false
                            releaseForms: []
                            hasCustomPreview: false
                            videoSources:
                              "240": null
                              "720": null
                          - id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: 2025-01-01T00:00:00+00:00
                            isReady: true
                            counters:
                              likesCount: 0
                              tipsSumm: 0
                            files:
                              full:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 1629
                                height: 1629
                                size: 0
                                sources: []
                              thumb:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 960
                                height: 960
                                size: 0
                              squarePreview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 960
                                height: 960
                                size: 0
                            duration: 0
                            hasPosts: false
                            listStates:
                              - id: 123
                                type: posts
                                name: Posts
                                hasMedia: true
                                canAddMedia: false
                              - id: 123
                                type: stories
                                name: Stories
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: messages
                                name: Messages
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: streams
                                name: Streams
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: custom
                                name: custom category
                                hasMedia: false
                                canAddMedia: true
                              - id: 123
                                type: media_stickers
                                name: Uploads
                                hasMedia: false
                                canAddMedia: false
                            releaseForms: []
                            hasCustomPreview: false
                            videoSources:
                              "240": null
                              "720": null
                          - id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: 2025-01-01T00:00:00+00:00
                            isReady: true
                            counters:
                              likesCount: 0
                              tipsSumm: 0
                            files:
                              full:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 1629
                                height: 1629
                                size: 0
                                sources: []
                              thumb:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 960
                                height: 960
                                size: 0
                              squarePreview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 960
                                height: 960
                                size: 0
                            duration: 0
                            hasPosts: false
                            listStates:
                              - id: 123
                                type: posts
                                name: Posts
                                hasMedia: true
                                canAddMedia: false
                              - id: 123
                                type: stories
                                name: Stories
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: messages
                                name: Messages
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: streams
                                name: Streams
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: custom
                                name: custom category
                                hasMedia: false
                                canAddMedia: true
                              - id: 123
                                type: media_stickers
                                name: Uploads
                                hasMedia: false
                                canAddMedia: false
                            releaseForms: []
                            hasCustomPreview: false
                            videoSources:
                              "240": null
                              "720": null
                          - id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: 2025-01-01T00:00:00+00:00
                            isReady: true
                            counters:
                              likesCount: 0
                              tipsSumm: 0
                            files:
                              full:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 1629
                                height: 1629
                                size: 0
                                sources: []
                              thumb:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 960
                                height: 960
                                size: 0
                              squarePreview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 960
                                height: 960
                                size: 0
                            duration: 0
                            hasPosts: false
                            listStates:
                              - id: 123
                                type: posts
                                name: Posts
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: stories
                                name: Stories
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: messages
                                name: Messages
                                hasMedia: true
                                canAddMedia: false
                              - id: 123
                                type: streams
                                name: Streams
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: custom
                                name: custom category
                                hasMedia: false
                                canAddMedia: true
                              - id: 123
                                type: media_stickers
                                name: Uploads
                                hasMedia: false
                                canAddMedia: false
                            releaseForms: []
                            hasCustomPreview: false
                            videoSources:
                              "240": null
                              "720": null
                          - id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: 2025-01-01T00:00:00+00:00
                            isReady: true
                            counters:
                              likesCount: 0
                              tipsSumm: 0
                            files:
                              full:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 500
                                height: 500
                                size: 0
                                sources: []
                              thumb:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 500
                                height: 500
                                size: 0
                              squarePreview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 960
                                height: 960
                                size: 0
                            duration: 0
                            hasPosts: false
                            listStates:
                              - id: 123
                                type: posts
                                name: Posts
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: stories
                                name: Stories
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: messages
                                name: Messages
                                hasMedia: true
                                canAddMedia: false
                              - id: 123
                                type: streams
                                name: Streams
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: custom
                                name: custom category
                                hasMedia: false
                                canAddMedia: true
                              - id: 123
                                type: media_stickers
                                name: Uploads
                                hasMedia: false
                                canAddMedia: false
                            releaseForms: []
                            hasCustomPreview: false
                            videoSources:
                              "240": null
                              "720": null
                          - id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: 2025-01-01T00:00:00+00:00
                            isReady: true
                            counters:
                              likesCount: 0
                              tipsSumm: 0
                            files:
                              full:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 1280
                                height: 720
                                size: 0
                                sources: []
                              thumb:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 960
                                height: 540
                                size: 0
                              squarePreview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 960
                                height: 960
                                size: 0
                            duration: 0
                            hasPosts: false
                            listStates:
                              - id: 123
                                type: posts
                                name: Posts
                                hasMedia: true
                                canAddMedia: false
                              - id: 123
                                type: stories
                                name: Stories
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: messages
                                name: Messages
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: streams
                                name: Streams
                                hasMedia: false
                                canAddMedia: false
                              - id: 123
                                type: custom
                                name: custom category
                                hasMedia: false
                                canAddMedia: true
                              - id: 123
                                type: media_stickers
                                name: Uploads
                                hasMedia: false
                                canAddMedia: false
                            releaseForms: []
                            hasCustomPreview: false
                            videoSources:
                              "240": null
                              "720": null
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            type:
                              type: string
                              example: audio
                            convertedToVideo:
                              type: boolean
                              example: false
                            canView:
                              type: boolean
                              example: true
                            hasError:
                              type: boolean
                              example: false
                            createdAt:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            isReady:
                              type: boolean
                              example: true
                            counters:
                              type: object
                              properties:
                                likesCount:
                                  type: integer
                                  example: 0
                                tipsSumm:
                                  type: integer
                                  example: 0
                            files:
                              type: object
                              properties:
                                full:
                                  type: object
                                  properties:
                                    url:
                                      type: string
                                      example: https://cdn2.onlyfans.com/files/...
                                    width:
                                      type: integer
                                      example: 0
                                    height:
                                      type: integer
                                      example: 0
                                    size:
                                      type: integer
                                      example: 0
                                    sources:
                                      type: array
                                      example: []
                                thumb:
                                  type: string
                                  example: null
                                  nullable: true
                                preview:
                                  type: string
                                  example: null
                                  nullable: true
                                squarePreview:
                                  type: string
                                  example: null
                                  nullable: true
                            duration:
                              type: integer
                              example: 3
                            hasPosts:
                              type: boolean
                              example: false
                            listStates:
                              type: array
                              example:
                                - id: 123
                                  type: posts
                                  name: Posts
                                  hasMedia: false
                                  canAddMedia: false
                                - id: 123
                                  type: stories
                                  name: Stories
                                  hasMedia: false
                                  canAddMedia: false
                                - id: 123
                                  type: messages
                                  name: Messages
                                  hasMedia: true
                                  canAddMedia: false
                                - id: 123
                                  type: streams
                                  name: Streams
                                  hasMedia: false
                                  canAddMedia: false
                                - id: 123
                                  type: custom
                                  name: custom category
                                  hasMedia: false
                                  canAddMedia: true
                                - id: 123
                                  type: media_stickers
                                  name: Uploads
                                  hasMedia: false
                                  canAddMedia: false
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  type:
                                    type: string
                                    example: posts
                                  name:
                                    type: string
                                    example: Posts
                                  hasMedia:
                                    type: boolean
                                    example: false
                                  canAddMedia:
                                    type: boolean
                                    example: false
                            releaseForms:
                              type: array
                              example: []
                            hasCustomPreview:
                              type: boolean
                              example: false
                            videoSources:
                              type: object
                              properties:
                                "240":
                                  type: string
                                  example: null
                                  nullable: true
                                "720":
                                  type: string
                                  example: null
                                  nullable: true
                      hasMore:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999960
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49989
      tags:
        - Media Vault
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Upload Media to Vault (/api-reference/media-vault/upload-media-to-vault)

Upload a media file directly to your vault.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/media/vault
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/media/vault:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Upload Media to Vault
      operationId: uploadMediaToVault
      description: Upload a media file directly to your vault.
      parameters: []
      responses:
        "200":
          description: Synchronous upload (default)
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 1234567890
                    type: photo
                    convertedToVideo: false
                    canView: true
                    hasError: false
                    createdAt: 2026-04-03T16:16:36+00:00
                    isReady: false
                    files:
                      full:
                        url: null
                        width: 0
                        height: 0
                        size: 0
                        sources: []
                      thumb: null
                      preview: null
                      squarePreview: null
                    duration: 0
                    releaseForms: []
                    hasCustomPreview: false
                  _meta:
                    _credits:
                      used: 3
                      balance: 636132
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1234567890
                      type:
                        type: string
                        example: photo
                      convertedToVideo:
                        type: boolean
                        example: false
                      canView:
                        type: boolean
                        example: true
                      hasError:
                        type: boolean
                        example: false
                      createdAt:
                        type: string
                        example: 2026-04-03T16:16:36+00:00
                      isReady:
                        type: boolean
                        example: false
                      files:
                        type: object
                        properties:
                          full:
                            type: object
                            properties:
                              url:
                                type: string
                                example: null
                                nullable: true
                              width:
                                type: integer
                                example: 0
                              height:
                                type: integer
                                example: 0
                              size:
                                type: integer
                                example: 0
                              sources:
                                type: array
                                example: []
                          thumb:
                            type: string
                            example: null
                            nullable: true
                          preview:
                            type: string
                            example: null
                            nullable: true
                          squarePreview:
                            type: string
                            example: null
                            nullable: true
                      duration:
                        type: integer
                        example: 0
                      releaseForms:
                        type: array
                        example: []
                      hasCustomPreview:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 3
                          balance:
                            type: integer
                            example: 636132
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
        "202":
          description: Async upload (async=true)
          content:
            application/json:
              schema:
                type: object
                example:
                  status: pending
                  prefixed_id: ofapi_media_abc123def456abc123def456abc123de
                  polling_url: https://app.onlyfansapi.com/api/acct_abc123def456/media/uploads/ofapi_media_abc123def456abc123def456abc123de/status
                properties:
                  status:
                    type: string
                    example: pending
                  prefixed_id:
                    type: string
                    example: ofapi_media_abc123def456abc123def456abc123de
                  polling_url:
                    type: string
                    example: https://app.onlyfansapi.com/api/acct_abc123def456/media/uploads/ofapi_media_abc123def456abc123def456abc123de/status
      tags:
        - Media Vault
      requestBody:
        required: false
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                  description: "The file to upload. Required if `file_url` is not provided.
                    Maximum file size: 100 MB (limited by Cloudflare)."
                file_url:
                  type: string
                  description: A URL to download the file from. Required if `file` is not
                    provided. Maximum file size depends on the subscription
                    configuration.
                  example: https://example.com/media/photo.jpg
                async:
                  type: boolean
                  description: Set to `true` to process uploads in the background. Returns a
                    `polling_url` to check status. Recommended for large files.
                  example: true
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Add Media To List (/api-reference/media-vault-lists/add-media-to-list)

Add one or multiple media to a list.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/media/vault/lists/{list_id}/media
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/media/vault/lists/{list_id}/media:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: list_id
        description: The ID of the list.
        example: quibusdam
        required: true
        schema:
          type: string
    post:
      summary: Add Media To List
      operationId: addMediaToList
      description: Add one or multiple media to a list.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    type: custom
                    name: My list
                    hasMedia: true
                    canUpdate: true
                    canDelete: true
                    videosCount: 0
                    photosCount: 1
                    gifsCount: 0
                    audiosCount: 0
                    medias:
                      - type: photo
                        url: https://cdn2.onlyfans.com/files/...
                  _meta:
                    _credits:
                      used: 1
                      balance: 972
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 996
                      remaining_day: 49917
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      type:
                        type: string
                        example: custom
                      name:
                        type: string
                        example: My list
                      hasMedia:
                        type: boolean
                        example: true
                      canUpdate:
                        type: boolean
                        example: true
                      canDelete:
                        type: boolean
                        example: true
                      videosCount:
                        type: integer
                        example: 0
                      photosCount:
                        type: integer
                        example: 1
                      gifsCount:
                        type: integer
                        example: 0
                      audiosCount:
                        type: integer
                        example: 0
                      medias:
                        type: array
                        example:
                          - type: photo
                            url: https://cdn2.onlyfans.com/files/...
                        items:
                          type: object
                          properties:
                            type:
                              type: string
                              example: photo
                            url:
                              type: string
                              example: https://cdn2.onlyfans.com/files/...
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 972
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 996
                          remaining_day:
                            type: integer
                            example: 49917
      tags:
        - Media Vault Lists
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                mediaIds:
                  type: array
                  description: Array of media IDs to add.
                  example:
                    - 1234567890
                  items:
                    type: string
              required:
                - mediaIds
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Create Vault List (/api-reference/media-vault-lists/create-vault-list)

Create a new Vault list.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/media/vault/lists
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/media/vault/lists:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Create Vault List
      operationId: createVaultList
      description: Create a new Vault list.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    type: custom
                    name: My new list
                    hasMedia: false
                    canUpdate: true
                    canDelete: true
                    videosCount: 0
                    photosCount: 0
                    gifsCount: 0
                    audiosCount: 0
                    medias: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 994
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 996
                      remaining_day: 49943
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      type:
                        type: string
                        example: custom
                      name:
                        type: string
                        example: My new list
                      hasMedia:
                        type: boolean
                        example: false
                      canUpdate:
                        type: boolean
                        example: true
                      canDelete:
                        type: boolean
                        example: true
                      videosCount:
                        type: integer
                        example: 0
                      photosCount:
                        type: integer
                        example: 0
                      gifsCount:
                        type: integer
                        example: 0
                      audiosCount:
                        type: integer
                        example: 0
                      medias:
                        type: array
                        example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 994
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 996
                          remaining_day:
                            type: integer
                            example: 49943
      tags:
        - Media Vault Lists
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The name of your new list
                  example: My new list
              required:
                - name
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Delete Vault List (/api-reference/media-vault-lists/delete-vault-list)

Delete a Vault list.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/media/vault/lists/{list_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/media/vault/lists/{list_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: list_id
        description: The ID of the list
        example: "123"
        required: true
        schema:
          type: string
    delete:
      summary: Delete Vault List
      operationId: deleteVaultList
      description: Delete a Vault list.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 992
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49941
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 992
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49941
      tags:
        - Media Vault Lists
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Vault Lists (/api-reference/media-vault-lists/list-vault-lists)

List your Vault lists (categories).

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/media/vault/lists
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/media/vault/lists:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Vault Lists
      operationId: listVaultLists
      description: List your Vault lists (categories).
      parameters:
        - in: query
          name: query
          description: Optionally, find a list by its name.
          example: My list name
          required: false
          schema:
            type: string
            description: Optionally, find a list by its name.
            example: My list name
        - in: query
          name: limit
          description: "Number of media to return per page. Default: `24`"
          example: 24
          required: false
          schema:
            type: integer
            description: "Number of media to return per page. Default: `24`"
            example: 24
        - in: query
          name: offset
          description: The offset used for pagination. Default `0`
          example: 0
          required: false
          schema:
            type: integer
            description: The offset used for pagination. Default `0`
            example: 0
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - id: 123
                        type: stories
                        name: Stories
                        hasMedia: false
                        canUpdate: false
                        canDelete: false
                        videosCount: 0
                        photosCount: 0
                        gifsCount: 0
                        audiosCount: 0
                        medias: []
                      - id: 123
                        type: streams
                        name: Streams
                        hasMedia: false
                        canUpdate: false
                        canDelete: false
                        videosCount: 0
                        photosCount: 0
                        gifsCount: 0
                        audiosCount: 0
                        medias: []
                      - id: 123
                        type: media_stickers
                        name: Uploads
                        hasMedia: false
                        canUpdate: false
                        canDelete: false
                        videosCount: 0
                        photosCount: 0
                        gifsCount: 0
                        audiosCount: 0
                        medias: []
                      - id: 123
                        type: posts
                        name: Posts
                        hasMedia: true
                        canUpdate: false
                        canDelete: false
                        videosCount: 0
                        photosCount: 5
                        gifsCount: 0
                        audiosCount: 0
                        medias:
                          - type: photo
                            url: https://cdn2.onlyfans.com/files/...
                      - id: 123
                        type: custom
                        name: custom category
                        hasMedia: false
                        canUpdate: true
                        canDelete: true
                        videosCount: 0
                        photosCount: 0
                        gifsCount: 0
                        audiosCount: 0
                        medias: []
                      - id: 123
                        type: messages
                        name: Messages
                        hasMedia: true
                        canUpdate: false
                        canDelete: false
                        videosCount: 1
                        photosCount: 4
                        gifsCount: 0
                        audiosCount: 2
                        medias:
                          - type: photo
                            url: https://cdn2.onlyfans.com/files/...
                    all:
                      videosCount: 1
                      photosCount: 9
                      gifsCount: 0
                      audiosCount: 2
                      medias:
                        - type: photo
                          url: https://cdn2.onlyfans.com/files/...
                    hasMore: false
                    canCreateVaultLists: true
                    order: asc
                    sort: default
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999945
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49968
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - id: 123
                            type: stories
                            name: Stories
                            hasMedia: false
                            canUpdate: false
                            canDelete: false
                            videosCount: 0
                            photosCount: 0
                            gifsCount: 0
                            audiosCount: 0
                            medias: []
                          - id: 123
                            type: streams
                            name: Streams
                            hasMedia: false
                            canUpdate: false
                            canDelete: false
                            videosCount: 0
                            photosCount: 0
                            gifsCount: 0
                            audiosCount: 0
                            medias: []
                          - id: 123
                            type: media_stickers
                            name: Uploads
                            hasMedia: false
                            canUpdate: false
                            canDelete: false
                            videosCount: 0
                            photosCount: 0
                            gifsCount: 0
                            audiosCount: 0
                            medias: []
                          - id: 123
                            type: posts
                            name: Posts
                            hasMedia: true
                            canUpdate: false
                            canDelete: false
                            videosCount: 0
                            photosCount: 5
                            gifsCount: 0
                            audiosCount: 0
                            medias:
                              - type: photo
                                url: https://cdn2.onlyfans.com/files/...
                          - id: 123
                            type: custom
                            name: custom category
                            hasMedia: false
                            canUpdate: true
                            canDelete: true
                            videosCount: 0
                            photosCount: 0
                            gifsCount: 0
                            audiosCount: 0
                            medias: []
                          - id: 123
                            type: messages
                            name: Messages
                            hasMedia: true
                            canUpdate: false
                            canDelete: false
                            videosCount: 1
                            photosCount: 4
                            gifsCount: 0
                            audiosCount: 2
                            medias:
                              - type: photo
                                url: https://cdn2.onlyfans.com/files/...
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            type:
                              type: string
                              example: stories
                            name:
                              type: string
                              example: Stories
                            hasMedia:
                              type: boolean
                              example: false
                            canUpdate:
                              type: boolean
                              example: false
                            canDelete:
                              type: boolean
                              example: false
                            videosCount:
                              type: integer
                              example: 0
                            photosCount:
                              type: integer
                              example: 0
                            gifsCount:
                              type: integer
                              example: 0
                            audiosCount:
                              type: integer
                              example: 0
                            medias:
                              type: array
                              example: []
                      all:
                        type: object
                        properties:
                          videosCount:
                            type: integer
                            example: 1
                          photosCount:
                            type: integer
                            example: 9
                          gifsCount:
                            type: integer
                            example: 0
                          audiosCount:
                            type: integer
                            example: 2
                          medias:
                            type: array
                            example:
                              - type: photo
                                url: https://cdn2.onlyfans.com/files/...
                            items:
                              type: object
                              properties:
                                type:
                                  type: string
                                  example: photo
                                url:
                                  type: string
                                  example: https://cdn2.onlyfans.com/files/...
                      hasMore:
                        type: boolean
                        example: false
                      canCreateVaultLists:
                        type: boolean
                        example: true
                      order:
                        type: string
                        example: asc
                      sort:
                        type: string
                        example: default
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999945
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49968
      tags:
        - Media Vault Lists
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Remove Media From List (/api-reference/media-vault-lists/remove-media-from-list)

Remove one or multiple media from a list.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/media/vault/lists/{list_id}/media
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/media/vault/lists/{list_id}/media:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: list_id
        description: The ID of the list.
        example: quibusdam
        required: true
        schema:
          type: string
    delete:
      summary: Remove Media From List
      operationId: removeMediaFromList
      description: Remove one or multiple media from a list.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    type: custom
                    name: My list
                    hasMedia: false
                    canUpdate: true
                    canDelete: true
                    videosCount: 0
                    photosCount: 0
                    gifsCount: 0
                    audiosCount: 0
                    medias: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 971
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49916
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      type:
                        type: string
                        example: custom
                      name:
                        type: string
                        example: My list
                      hasMedia:
                        type: boolean
                        example: false
                      canUpdate:
                        type: boolean
                        example: true
                      canDelete:
                        type: boolean
                        example: true
                      videosCount:
                        type: integer
                        example: 0
                      photosCount:
                        type: integer
                        example: 0
                      gifsCount:
                        type: integer
                        example: 0
                      audiosCount:
                        type: integer
                        example: 0
                      medias:
                        type: array
                        example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 971
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49916
      tags:
        - Media Vault Lists
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                mediaIds:
                  type: array
                  description: Array of media IDs to delete.
                  example:
                    - 1234567890
                  items:
                    type: string
              required:
                - mediaIds
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Rename Vault List (/api-reference/media-vault-lists/rename-vault-list)

Rename a Vault list.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml put /api/{account}/media/vault/lists/{list_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/media/vault/lists/{list_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: list_id
        description: The ID of the list
        example: "123"
        required: true
        schema:
          type: string
    put:
      summary: Rename Vault List
      operationId: renameVaultList
      description: Rename a Vault list.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    type: custom
                    name: My new list name
                    hasMedia: false
                    canUpdate: true
                    canDelete: true
                    videosCount: 0
                    photosCount: 0
                    gifsCount: 0
                    audiosCount: 0
                    medias: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 990
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49937
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      type:
                        type: string
                        example: custom
                      name:
                        type: string
                        example: My new list name
                      hasMedia:
                        type: boolean
                        example: false
                      canUpdate:
                        type: boolean
                        example: true
                      canDelete:
                        type: boolean
                        example: true
                      videosCount:
                        type: integer
                        example: 0
                      photosCount:
                        type: integer
                        example: 0
                      gifsCount:
                        type: integer
                        example: 0
                      audiosCount:
                        type: integer
                        example: 0
                      medias:
                        type: array
                        example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 990
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49937
      tags:
        - Media Vault Lists
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The new name for the vault list. Must not be greater than 255
                    characters.
                  example: My renamed list
              required:
                - name
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Show Vault List (/api-reference/media-vault-lists/show-vault-list)

Show a Vault list.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/media/vault/lists/{list_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/media/vault/lists/{list_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: list_id
        description: The ID of the list
        example: "123"
        required: true
        schema:
          type: string
    get:
      summary: Show Vault List
      operationId: showVaultList
      description: Show a Vault list.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    type: custom
                    name: My list
                    hasMedia: false
                    canUpdate: true
                    canDelete: true
                    videosCount: 0
                    photosCount: 0
                    gifsCount: 0
                    audiosCount: 0
                    medias: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 989
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49936
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      type:
                        type: string
                        example: custom
                      name:
                        type: string
                        example: My list
                      hasMedia:
                        type: boolean
                        example: false
                      canUpdate:
                        type: boolean
                        example: true
                      canDelete:
                        type: boolean
                        example: true
                      videosCount:
                        type: integer
                        example: 0
                      photosCount:
                        type: integer
                        example: 0
                      gifsCount:
                        type: integer
                        example: 0
                      audiosCount:
                        type: integer
                        example: 0
                      medias:
                        type: array
                        example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 989
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49936
      tags:
        - Media Vault Lists
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Notification Counts (/api-reference/notifications/get-notification-counts)

Get a quick overview of all unread notification types

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/notifications/counts
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/notifications/counts:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Notification Counts
      operationId: getNotificationCounts
      description: Get a quick overview of all unread notification types
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    all: 123
                    subscribed: 123
                    purchases: 123
                    tip: 123
                    tags: 123
                    commented: 123
                    mentioned: 123
                    favorited: 123
                    message: 123
                    deactivated_media: 123
                    system: 123
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000000027
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49997
                properties:
                  data:
                    type: object
                    properties:
                      all:
                        type: integer
                        example: 123
                      subscribed:
                        type: integer
                        example: 123
                      purchases:
                        type: integer
                        example: 123
                      tip:
                        type: integer
                        example: 123
                      tags:
                        type: integer
                        example: 123
                      commented:
                        type: integer
                        example: 123
                      mentioned:
                        type: integer
                        example: 123
                      favorited:
                        type: integer
                        example: 123
                      message:
                        type: integer
                        example: 123
                      deactivated_media:
                        type: integer
                        example: 123
                      system:
                        type: integer
                        example: 123
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000000027
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49997
      tags:
        - Notifications
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Notification Tabs Order (/api-reference/notifications/get-notification-tabs-order)

Get the order of an account's notification tabs as displayed on the OnlyFans notifications page

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/notifications/tabs-order
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/notifications/tabs-order:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Notification Tabs Order
      operationId: getNotificationTabsOrder
      description: Get the order of an account's notification tabs as displayed on the
        OnlyFans notifications page
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - all
                    - subscribed
                    - deactivated_media
                    - purchases
                    - tip
                    - tags
                    - commented
                    - mentioned
                    - favorited
                    - message
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000000025
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999998
                      remaining_day: 49995
                properties:
                  data:
                    type: array
                    example:
                      - all
                      - subscribed
                      - deactivated_media
                      - purchases
                      - tip
                      - tags
                      - commented
                      - mentioned
                      - favorited
                      - message
                    items:
                      type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000000025
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999998
                          remaining_day:
                            type: integer
                            example: 49995
      tags:
        - Notifications
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Notifications (/api-reference/notifications/list-notifications)

List all notifications for the account

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/notifications
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/notifications:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Notifications
      operationId: listNotifications
      description: List all notifications for the account
      parameters:
        - in: query
          name: type
          description: Filter notifications by a specific type
          example: mentions
          required: false
          schema:
            type: string
            description: Filter notifications by a specific type
            example: mentions
            enum:
              - all
              - subscriptions
              - onlyfans
              - purchases
              - tips
              - tags
              - comments
              - mentions
              - likes
              - promotions
        - in: query
          name: limit
          description: The number of notifications. Default `10`
          example: 10
          required: false
          schema:
            type: integer
            description: The number of notifications. Default `10`
            example: 10
        - in: query
          name: from_id
          description: Used for pagination. This value should be the ID of the previous
            response's last notification.
          example: 123
          required: false
          schema:
            type: integer
            description: Used for pagination. This value should be the ID of the previous
              response's last notification.
            example: 123
        - in: query
          name: skip_users
          description: Whether to skip user details. Defaults to `all`.
          example: all
          required: false
          schema:
            type: string
            description: Whether to skip user details. Defaults to `all`.
            example: all
            enum:
              - all
              - none
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - id: 123
                        type: subscribed
                        createdAt: 2025-01-01T00:00:00+00:00
                        isRead: true
                        text: subscribed to your profile!
                        replacePairs:
                          "{SUBSCRIBER_LINK}": <a href='https://onlyfans.com/username'>Name</a>
                          "{PRICE}": free
                        subType: new_subscriber_trial
                        canGoToProfile: true
                        user:
                          id: 123
                          _view: n
                    hasMore: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000000015
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49973
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - id: 123
                            type: subscribed
                            createdAt: 2025-01-01T00:00:00+00:00
                            isRead: true
                            text: subscribed to your profile!
                            replacePairs:
                              "{SUBSCRIBER_LINK}": <a href='https://onlyfans.com/username'>Name</a>
                              "{PRICE}": free
                            subType: new_subscriber_trial
                            canGoToProfile: true
                            user:
                              id: 123
                              _view: n
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            type:
                              type: string
                              example: subscribed
                            createdAt:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            isRead:
                              type: boolean
                              example: true
                            text:
                              type: string
                              example: subscribed to your profile!
                            replacePairs:
                              type: object
                              properties:
                                "{SUBSCRIBER_LINK}":
                                  type: string
                                  example: <a href='https://onlyfans.com/username'>Name</a>
                                "{PRICE}":
                                  type: string
                                  example: free
                            subType:
                              type: string
                              example: new_subscriber_trial
                            canGoToProfile:
                              type: boolean
                              example: true
                            user:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                _view:
                                  type: string
                                  example: n
                      hasMore:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000000015
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49973
      tags:
        - Notifications
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Mark All Notifications As Read (/api-reference/notifications/mark-all-notifications-as-read)

Mark all notifications of this account as read

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/notifications/mark-all-as-read
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/notifications/mark-all-as-read:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Mark All Notifications As Read
      operationId: markAllNotificationsAsRead
      description: Mark all notifications of this account as read
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000000014
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49972
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000000014
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49972
      tags:
        - Notifications
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Search Users In Notifications (/api-reference/notifications/search-users-in-notifications)

Search users that have appeared in your notifications

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/notifications/search-users
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/notifications/search-users:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Search Users In Notifications
      operationId: searchUsersInNotifications
      description: Search users that have appeared in your notifications
      parameters:
        - in: query
          name: query
          description: The query to search for. Can be either a name or username.
          example: User
          required: true
          schema:
            type: string
            description: The query to search for. Can be either a name or username.
            example: User
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - view: x
                      avatar: null
                      avatarThumbs: null
                      header: null
                      headerSize: null
                      headerThumbs: null
                      id: 123
                      name: Name
                      username: username
                      canLookStory: true
                      canCommentStory: true
                      hasNotViewedStory: false
                      isVerified: false
                      canPayInternal: true
                      hasScheduledStream: false
                      hasStream: false
                      hasStories: false
                      tipsEnabled: false
                      tipsTextEnabled: true
                      tipsMin: 5
                      tipsMinInternal: 1
                      tipsMax: 200
                      canEarn: false
                      canAddSubscriber: false
                      subscribePrice: 0
                      displayName: ""
                      notice: ""
                      isRestricted: false
                      canRestrict: true
                      subscribedBy: true
                      subscribedByExpire: false
                      subscribedByExpireDate: 2025-01-01T00:00:00+00:00
                      subscribedByAutoprolong: true
                      subscribedIsExpiredNow: false
                      currentSubscribePrice: 0
                      subscribedOn: true
                      subscribedOnExpiredNow: false
                      subscribedOnDuration: 23 days
                      listsStates:
                        - id: fans
                          type: fans
                          name: Fans
                          hasUser: true
                          canAddUser: false
                          cannotAddUserReason: ALREADY_EXISTS
                        - id: following
                          type: following
                          name: Following
                          hasUser: true
                          canAddUser: false
                          cannotAddUserReason: ALREADY_EXISTS
                        - id: friends
                          type: friends
                          name: Friends
                          hasUser: false
                          canAddUser: false
                          cannotAddUserReason: USER_NOT_PERFORMER
                        - id: 1181087239
                          type: custom
                          name: Low Spenders-1PM
                          hasUser: true
                          canAddUser: false
                          cannotAddUserReason: ALREADY_EXISTS
                        - id: muted
                          type: muted
                          name: Muted
                          hasUser: false
                          canAddUser: true
                          cannotAddUserReason: null
                        - id: recent
                          type: recent
                          name: Recent (last 24 hours)
                          hasUser: false
                          canAddUser: false
                          cannotAddUserReason: SYSTEM_LIST
                        - id: rebill_off
                          type: rebill_off
                          name: Renew Off
                          hasUser: false
                          canAddUser: false
                          cannotAddUserReason: null
                        - id: rebill_on
                          type: rebill_on
                          name: Renew On
                          hasUser: true
                          canAddUser: false
                          cannotAddUserReason: ALREADY_EXISTS
                        - id: tagged
                          type: tagged
                          name: Tagged
                          hasUser: false
                          canAddUser: false
                          cannotAddUserReason: SYSTEM_LIST
                      canReport: true
                      canReceiveChatMessage: true
                      hideChat: false
                      lastSeen: 2025-01-01T00:00:00+00:00
                      isPerformer: false
                      isRealPerformer: false
                      subscribedByData:
                        price: 0
                        newPrice: 0
                        regularPrice: 0
                        subscribePrice: 0
                        discountPercent: 0
                        discountPeriod: 1
                        subscribeAt: 2025-01-01T00:00:00+00:00
                        expiredAt: 2025-01-01T00:00:00+00:00
                        renewedAt: 2025-01-01T00:00:00+00:00
                        discountFinishedAt: null
                        discountStartedAt: null
                        status: null
                        isMuted: false
                        unsubscribeReason: No reason given
                        duration: 23 days
                        showPostsInFeed: true
                        subscribes:
                          - id: 123
                            userId: 123
                            subscriberId: 123
                            date: 2025-01-01T00:00:00+00:00
                            duration: 123
                            startDate: 2025-01-01T00:00:00+00:00
                            expireDate: 2025-01-01T00:00:00+00:00
                            cancelDate: null
                            price: 0
                            regularPrice: 0
                            discount: 0
                            earningId: 0
                            action: subscribe
                            type: auto
                            offerStart: null
                            offerEnd: null
                            isCurrent: true
                        hasActivePaidSubscriptions: false
                      subscribedOnData:
                        price: 5
                        newPrice: 20
                        regularPrice: 5
                        subscribePrice: 5
                        discountPercent: 0
                        discountPeriod: 1
                        subscribeAt: 2025-01-01T00:00:00+00:00
                        expiredAt: 2025-01-01T00:00:00+00:00
                        renewedAt: 2025-01-01T00:00:00+00:00
                        discountFinishedAt: null
                        discountStartedAt: null
                        status: null
                        isMuted: false
                        unsubscribeReason: No reason given
                        duration: 23 days
                        tipsSumm: 0
                        subscribesSumm: 4
                        messagesSumm: 0
                        postsSumm: 0
                        streamsSumm: 0
                        totalSumm: 4
                        lastActivity: 2025-01-01T00:00:00+00:00
                        recommendations: 0
                        subscribes:
                          - id: 123
                            userId: 213
                            subscriberId: 123
                            date: 2025-01-01T00:00:00+00:00
                            duration: 30
                            startDate: 2025-01-01T00:00:00+00:00
                            expireDate: 2025-01-01T00:00:00+00:00
                            cancelDate: null
                            price: 5
                            regularPrice: 20
                            discount: 75
                            earningId: 123
                            action: subscribe
                            type: promo
                            offerStart: 2025-01-01T00:00:00+00:00
                            offerEnd: 2025-01-01T00:00:00+00:00
                            isCurrent: true
                        hasActivePaidSubscriptions: true
                      canTrialSend: false
                      isBlocked: false
                      promoOffers: []
                      canUnsubscribe: true
                      isPendingAutoprolong: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000000011
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999998
                      remaining_day: 49959
                properties:
                  data:
                    type: array
                    example:
                      - view: x
                        avatar: null
                        avatarThumbs: null
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 123
                        name: Name
                        username: username
                        canLookStory: true
                        canCommentStory: true
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: true
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: ""
                        notice: ""
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: true
                        subscribedByExpire: false
                        subscribedByExpireDate: 2025-01-01T00:00:00+00:00
                        subscribedByAutoprolong: true
                        subscribedIsExpiredNow: false
                        currentSubscribePrice: 0
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: 23 days
                        listsStates:
                          - id: fans
                            type: fans
                            name: Fans
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: USER_NOT_PERFORMER
                          - id: 1181087239
                            type: custom
                            name: Low Spenders-1PM
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          - id: recent
                            type: recent
                            name: Recent (last 24 hours)
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: rebill_off
                            type: rebill_off
                            name: Renew Off
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          - id: rebill_on
                            type: rebill_on
                            name: Renew On
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                        canReport: true
                        canReceiveChatMessage: true
                        hideChat: false
                        lastSeen: 2025-01-01T00:00:00+00:00
                        isPerformer: false
                        isRealPerformer: false
                        subscribedByData:
                          price: 0
                          newPrice: 0
                          regularPrice: 0
                          subscribePrice: 0
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: 2025-01-01T00:00:00+00:00
                          expiredAt: 2025-01-01T00:00:00+00:00
                          renewedAt: 2025-01-01T00:00:00+00:00
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: null
                          isMuted: false
                          unsubscribeReason: No reason given
                          duration: 23 days
                          showPostsInFeed: true
                          subscribes:
                            - id: 123
                              userId: 123
                              subscriberId: 123
                              date: 2025-01-01T00:00:00+00:00
                              duration: 123
                              startDate: 2025-01-01T00:00:00+00:00
                              expireDate: 2025-01-01T00:00:00+00:00
                              cancelDate: null
                              price: 0
                              regularPrice: 0
                              discount: 0
                              earningId: 0
                              action: subscribe
                              type: auto
                              offerStart: null
                              offerEnd: null
                              isCurrent: true
                          hasActivePaidSubscriptions: false
                        subscribedOnData:
                          price: 5
                          newPrice: 20
                          regularPrice: 5
                          subscribePrice: 5
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: 2025-01-01T00:00:00+00:00
                          expiredAt: 2025-01-01T00:00:00+00:00
                          renewedAt: 2025-01-01T00:00:00+00:00
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: null
                          isMuted: false
                          unsubscribeReason: No reason given
                          duration: 23 days
                          tipsSumm: 0
                          subscribesSumm: 4
                          messagesSumm: 0
                          postsSumm: 0
                          streamsSumm: 0
                          totalSumm: 4
                          lastActivity: 2025-01-01T00:00:00+00:00
                          recommendations: 0
                          subscribes:
                            - id: 123
                              userId: 213
                              subscriberId: 123
                              date: 2025-01-01T00:00:00+00:00
                              duration: 30
                              startDate: 2025-01-01T00:00:00+00:00
                              expireDate: 2025-01-01T00:00:00+00:00
                              cancelDate: null
                              price: 5
                              regularPrice: 20
                              discount: 75
                              earningId: 123
                              action: subscribe
                              type: promo
                              offerStart: 2025-01-01T00:00:00+00:00
                              offerEnd: 2025-01-01T00:00:00+00:00
                              isCurrent: true
                          hasActivePaidSubscriptions: true
                        canTrialSend: false
                        isBlocked: false
                        promoOffers: []
                        canUnsubscribe: true
                        isPendingAutoprolong: false
                    items:
                      type: object
                      properties:
                        view:
                          type: string
                          example: x
                        avatar:
                          type: string
                          example: null
                          nullable: true
                        avatarThumbs:
                          type: string
                          example: null
                          nullable: true
                        header:
                          type: string
                          example: null
                          nullable: true
                        headerSize:
                          type: string
                          example: null
                          nullable: true
                        headerThumbs:
                          type: string
                          example: null
                          nullable: true
                        id:
                          type: integer
                          example: 123
                        name:
                          type: string
                          example: Name
                        username:
                          type: string
                          example: username
                        canLookStory:
                          type: boolean
                          example: true
                        canCommentStory:
                          type: boolean
                          example: true
                        hasNotViewedStory:
                          type: boolean
                          example: false
                        isVerified:
                          type: boolean
                          example: false
                        canPayInternal:
                          type: boolean
                          example: true
                        hasScheduledStream:
                          type: boolean
                          example: false
                        hasStream:
                          type: boolean
                          example: false
                        hasStories:
                          type: boolean
                          example: false
                        tipsEnabled:
                          type: boolean
                          example: false
                        tipsTextEnabled:
                          type: boolean
                          example: true
                        tipsMin:
                          type: integer
                          example: 5
                        tipsMinInternal:
                          type: integer
                          example: 1
                        tipsMax:
                          type: integer
                          example: 200
                        canEarn:
                          type: boolean
                          example: false
                        canAddSubscriber:
                          type: boolean
                          example: false
                        subscribePrice:
                          type: integer
                          example: 0
                        displayName:
                          type: string
                          example: ""
                        notice:
                          type: string
                          example: ""
                        isRestricted:
                          type: boolean
                          example: false
                        canRestrict:
                          type: boolean
                          example: true
                        subscribedBy:
                          type: boolean
                          example: true
                        subscribedByExpire:
                          type: boolean
                          example: false
                        subscribedByExpireDate:
                          type: string
                          example: 2025-01-01T00:00:00+00:00
                        subscribedByAutoprolong:
                          type: boolean
                          example: true
                        subscribedIsExpiredNow:
                          type: boolean
                          example: false
                        currentSubscribePrice:
                          type: integer
                          example: 0
                        subscribedOn:
                          type: boolean
                          example: true
                        subscribedOnExpiredNow:
                          type: boolean
                          example: false
                        subscribedOnDuration:
                          type: string
                          example: 23 days
                        listsStates:
                          type: array
                          example:
                            - id: fans
                              type: fans
                              name: Fans
                              hasUser: true
                              canAddUser: false
                              cannotAddUserReason: ALREADY_EXISTS
                            - id: following
                              type: following
                              name: Following
                              hasUser: true
                              canAddUser: false
                              cannotAddUserReason: ALREADY_EXISTS
                            - id: friends
                              type: friends
                              name: Friends
                              hasUser: false
                              canAddUser: false
                              cannotAddUserReason: USER_NOT_PERFORMER
                            - id: 1181087239
                              type: custom
                              name: Low Spenders-1PM
                              hasUser: true
                              canAddUser: false
                              cannotAddUserReason: ALREADY_EXISTS
                            - id: muted
                              type: muted
                              name: Muted
                              hasUser: false
                              canAddUser: true
                              cannotAddUserReason: null
                            - id: recent
                              type: recent
                              name: Recent (last 24 hours)
                              hasUser: false
                              canAddUser: false
                              cannotAddUserReason: SYSTEM_LIST
                            - id: rebill_off
                              type: rebill_off
                              name: Renew Off
                              hasUser: false
                              canAddUser: false
                              cannotAddUserReason: null
                            - id: rebill_on
                              type: rebill_on
                              name: Renew On
                              hasUser: true
                              canAddUser: false
                              cannotAddUserReason: ALREADY_EXISTS
                            - id: tagged
                              type: tagged
                              name: Tagged
                              hasUser: false
                              canAddUser: false
                              cannotAddUserReason: SYSTEM_LIST
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: fans
                              type:
                                type: string
                                example: fans
                              name:
                                type: string
                                example: Fans
                              hasUser:
                                type: boolean
                                example: true
                              canAddUser:
                                type: boolean
                                example: false
                              cannotAddUserReason:
                                type: string
                                example: ALREADY_EXISTS
                        canReport:
                          type: boolean
                          example: true
                        canReceiveChatMessage:
                          type: boolean
                          example: true
                        hideChat:
                          type: boolean
                          example: false
                        lastSeen:
                          type: string
                          example: 2025-01-01T00:00:00+00:00
                        isPerformer:
                          type: boolean
                          example: false
                        isRealPerformer:
                          type: boolean
                          example: false
                        subscribedByData:
                          type: object
                          properties:
                            price:
                              type: integer
                              example: 0
                            newPrice:
                              type: integer
                              example: 0
                            regularPrice:
                              type: integer
                              example: 0
                            subscribePrice:
                              type: integer
                              example: 0
                            discountPercent:
                              type: integer
                              example: 0
                            discountPeriod:
                              type: integer
                              example: 1
                            subscribeAt:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            expiredAt:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            renewedAt:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            discountFinishedAt:
                              type: string
                              example: null
                              nullable: true
                            discountStartedAt:
                              type: string
                              example: null
                              nullable: true
                            status:
                              type: string
                              example: null
                              nullable: true
                            isMuted:
                              type: boolean
                              example: false
                            unsubscribeReason:
                              type: string
                              example: No reason given
                            duration:
                              type: string
                              example: 23 days
                            showPostsInFeed:
                              type: boolean
                              example: true
                            subscribes:
                              type: array
                              example:
                                - id: 123
                                  userId: 123
                                  subscriberId: 123
                                  date: 2025-01-01T00:00:00+00:00
                                  duration: 123
                                  startDate: 2025-01-01T00:00:00+00:00
                                  expireDate: 2025-01-01T00:00:00+00:00
                                  cancelDate: null
                                  price: 0
                                  regularPrice: 0
                                  discount: 0
                                  earningId: 0
                                  action: subscribe
                                  type: auto
                                  offerStart: null
                                  offerEnd: null
                                  isCurrent: true
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  userId:
                                    type: integer
                                    example: 123
                                  subscriberId:
                                    type: integer
                                    example: 123
                                  date:
                                    type: string
                                    example: 2025-01-01T00:00:00+00:00
                                  duration:
                                    type: integer
                                    example: 123
                                  startDate:
                                    type: string
                                    example: 2025-01-01T00:00:00+00:00
                                  expireDate:
                                    type: string
                                    example: 2025-01-01T00:00:00+00:00
                                  cancelDate:
                                    type: string
                                    example: null
                                    nullable: true
                                  price:
                                    type: integer
                                    example: 0
                                  regularPrice:
                                    type: integer
                                    example: 0
                                  discount:
                                    type: integer
                                    example: 0
                                  earningId:
                                    type: integer
                                    example: 0
                                  action:
                                    type: string
                                    example: subscribe
                                  type:
                                    type: string
                                    example: auto
                                  offerStart:
                                    type: string
                                    example: null
                                    nullable: true
                                  offerEnd:
                                    type: string
                                    example: null
                                    nullable: true
                                  isCurrent:
                                    type: boolean
                                    example: true
                            hasActivePaidSubscriptions:
                              type: boolean
                              example: false
                        subscribedOnData:
                          type: object
                          properties:
                            price:
                              type: integer
                              example: 5
                            newPrice:
                              type: integer
                              example: 20
                            regularPrice:
                              type: integer
                              example: 5
                            subscribePrice:
                              type: integer
                              example: 5
                            discountPercent:
                              type: integer
                              example: 0
                            discountPeriod:
                              type: integer
                              example: 1
                            subscribeAt:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            expiredAt:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            renewedAt:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            discountFinishedAt:
                              type: string
                              example: null
                              nullable: true
                            discountStartedAt:
                              type: string
                              example: null
                              nullable: true
                            status:
                              type: string
                              example: null
                              nullable: true
                            isMuted:
                              type: boolean
                              example: false
                            unsubscribeReason:
                              type: string
                              example: No reason given
                            duration:
                              type: string
                              example: 23 days
                            tipsSumm:
                              type: integer
                              example: 0
                            subscribesSumm:
                              type: integer
                              example: 4
                            messagesSumm:
                              type: integer
                              example: 0
                            postsSumm:
                              type: integer
                              example: 0
                            streamsSumm:
                              type: integer
                              example: 0
                            totalSumm:
                              type: integer
                              example: 4
                            lastActivity:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            recommendations:
                              type: integer
                              example: 0
                            subscribes:
                              type: array
                              example:
                                - id: 123
                                  userId: 213
                                  subscriberId: 123
                                  date: 2025-01-01T00:00:00+00:00
                                  duration: 30
                                  startDate: 2025-01-01T00:00:00+00:00
                                  expireDate: 2025-01-01T00:00:00+00:00
                                  cancelDate: null
                                  price: 5
                                  regularPrice: 20
                                  discount: 75
                                  earningId: 123
                                  action: subscribe
                                  type: promo
                                  offerStart: 2025-01-01T00:00:00+00:00
                                  offerEnd: 2025-01-01T00:00:00+00:00
                                  isCurrent: true
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  userId:
                                    type: integer
                                    example: 213
                                  subscriberId:
                                    type: integer
                                    example: 123
                                  date:
                                    type: string
                                    example: 2025-01-01T00:00:00+00:00
                                  duration:
                                    type: integer
                                    example: 30
                                  startDate:
                                    type: string
                                    example: 2025-01-01T00:00:00+00:00
                                  expireDate:
                                    type: string
                                    example: 2025-01-01T00:00:00+00:00
                                  cancelDate:
                                    type: string
                                    example: null
                                    nullable: true
                                  price:
                                    type: integer
                                    example: 5
                                  regularPrice:
                                    type: integer
                                    example: 20
                                  discount:
                                    type: integer
                                    example: 75
                                  earningId:
                                    type: integer
                                    example: 123
                                  action:
                                    type: string
                                    example: subscribe
                                  type:
                                    type: string
                                    example: promo
                                  offerStart:
                                    type: string
                                    example: 2025-01-01T00:00:00+00:00
                                  offerEnd:
                                    type: string
                                    example: 2025-01-01T00:00:00+00:00
                                  isCurrent:
                                    type: boolean
                                    example: true
                            hasActivePaidSubscriptions:
                              type: boolean
                              example: true
                        canTrialSend:
                          type: boolean
                          example: false
                        isBlocked:
                          type: boolean
                          example: false
                        promoOffers:
                          type: array
                          example: []
                        canUnsubscribe:
                          type: boolean
                          example: true
                        isPendingAutoprolong:
                          type: boolean
                          example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000000011
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999998
                          remaining_day:
                            type: integer
                            example: 49959
      tags:
        - Notifications
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Update Notification Tabs Order (/api-reference/notifications/update-notification-tabs-order)

Update the order of an account's notification tabs as displayed on the OnlyFans notifications page

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml put /api/{account}/notifications/tabs-order
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/notifications/tabs-order:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    put:
      summary: Update Notification Tabs Order
      operationId: updateNotificationTabsOrder
      description: Update the order of an account's notification tabs as displayed on
        the OnlyFans notifications page
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000000018
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999997
                      remaining_day: 49979
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000000018
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999997
                          remaining_day:
                            type: integer
                            example: 49979
      tags:
        - Notifications
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tabs:
                  type: array
                  description: "Array of tab keys. Must include exactly these: all, subscriptions,
                    onlyfans, purchases, tips, tags, comments, mentions, likes,
                    promotions."
                  example:
                    - all
                    - subscriptions
                    - onlyfans
                    - purchases
                    - tips
                    - tags
                    - comments
                    - mentions
                    - likes
                    - promotions
                  items:
                    type: string
              required:
                - tabs
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Account Balances (/api-reference/payouts/get-account-balances)

Get the current available and pending balances for the account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/payouts/balances
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/payouts/balances:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Account Balances
      operationId: getAccountBalances
      description: Get the current available and pending balances for the account.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    payoutAvailable: 123.45
                    payoutPending: 123.45
                    currency: USD
                    minPayoutSumm: 20
                    maxPayoutSumm: 213.45
                    withdrawalPeriodOptions:
                      - code: manual
                        name: Manual payouts
                      - code: weekly
                        name: Weekly payouts
                      - code: monthly
                        name: Monthly payouts
                    manualPayoutPendingDays: 7
                    withdrawalPeriod: manual
                  _meta:
                    _credits:
                      used: 1
                      balance: 25661
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 5000
                      remaining_minute: 999
                      remaining_day: 4994
                properties:
                  data:
                    type: object
                    properties:
                      payoutAvailable:
                        type: number
                        example: 123.45
                      payoutPending:
                        type: number
                        example: 123.45
                      currency:
                        type: string
                        example: USD
                      minPayoutSumm:
                        type: integer
                        example: 20
                      maxPayoutSumm:
                        type: number
                        example: 213.45
                      withdrawalPeriodOptions:
                        type: array
                        example:
                          - code: manual
                            name: Manual payouts
                          - code: weekly
                            name: Weekly payouts
                          - code: monthly
                            name: Monthly payouts
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                              example: manual
                            name:
                              type: string
                              example: Manual payouts
                      manualPayoutPendingDays:
                        type: integer
                        example: 7
                      withdrawalPeriod:
                        type: string
                        example: manual
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 25661
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 5000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 4994
      tags:
        - Payouts
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Earning Statistics (/api-reference/payouts/get-earning-statistics)

Get total and monthly time-series earning statistics for the account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/payouts/earning-statistics
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/payouts/earning-statistics:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Earning Statistics
      operationId: getEarningStatistics
      description: Get total and monthly time-series earning statistics for the account.
      parameters:
        - in: query
          name: startDate
          description: The start date for earning statistics. Keep empty to get all
            earnings.
          example: 2025-01-01 00:00:00
          required: false
          schema:
            type: string
            description: The start date for earning statistics. Keep empty to get all
              earnings.
            example: 2025-01-01 00:00:00
            nullable: true
        - in: query
          name: endDate
          description: The end date for earning statistics. Keep empty to get all earnings.
          example: 2025-01-31 23:59:59
          required: false
          schema:
            type: string
            description: The end date for earning statistics. Keep empty to get all
              earnings.
            example: 2025-01-31 23:59:59
            nullable: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      months:
                        "1735689661":
                          tips:
                            - time: 1735689661
                              net: 4
                              gross: 5
                          total_net: 100
                          total_gross: 125
                          subscribes:
                            - time: 1735689661
                              net: 16
                              gross: 20
                      total:
                        tips:
                          total_net: 123.45
                          total_gross: 123.45
                        all:
                          total_net: 123.45
                          total_gross: 123.45
                        subscribes:
                          total_net: 123.45
                          total_gross: 123.45
                        chat_messages:
                          total_net: 123.45
                          total_gross: 123.45
                        post:
                          total_net: 123.45
                          total_gross: 123.45
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999842
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49846
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: object
                        properties:
                          months:
                            type: object
                            properties:
                              "1735689661":
                                type: object
                                properties:
                                  tips:
                                    type: array
                                    example:
                                      - time: 1735689661
                                        net: 4
                                        gross: 5
                                    items:
                                      type: object
                                      properties:
                                        time:
                                          type: integer
                                          example: 1735689661
                                        net:
                                          type: integer
                                          example: 4
                                        gross:
                                          type: integer
                                          example: 5
                                  total_net:
                                    type: integer
                                    example: 100
                                  total_gross:
                                    type: integer
                                    example: 125
                                  subscribes:
                                    type: array
                                    example:
                                      - time: 1735689661
                                        net: 16
                                        gross: 20
                                    items:
                                      type: object
                                      properties:
                                        time:
                                          type: integer
                                          example: 1735689661
                                        net:
                                          type: integer
                                          example: 16
                                        gross:
                                          type: integer
                                          example: 20
                          total:
                            type: object
                            properties:
                              tips:
                                type: object
                                properties:
                                  total_net:
                                    type: number
                                    example: 123.45
                                  total_gross:
                                    type: number
                                    example: 123.45
                              all:
                                type: object
                                properties:
                                  total_net:
                                    type: number
                                    example: 123.45
                                  total_gross:
                                    type: number
                                    example: 123.45
                              subscribes:
                                type: object
                                properties:
                                  total_net:
                                    type: number
                                    example: 123.45
                                  total_gross:
                                    type: number
                                    example: 123.45
                              chat_messages:
                                type: object
                                properties:
                                  total_net:
                                    type: number
                                    example: 123.45
                                  total_gross:
                                    type: number
                                    example: 123.45
                              post:
                                type: object
                                properties:
                                  total_net:
                                    type: number
                                    example: 123.45
                                  total_gross:
                                    type: number
                                    example: 123.45
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999842
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49846
      tags:
        - Payouts
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Eligibility (/api-reference/payouts/get-eligibility)

Get the eligibility details for receiving payouts.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/payouts/eligibility
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/payouts/eligibility:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Eligibility
      operationId: getEligibility
      description: Get the eligibility details for receiving payouts.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    isVerifiedReason: false
                    canReceiveManualPayout: true
                    needUpdateBanking: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999846
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49850
                properties:
                  data:
                    type: object
                    properties:
                      isVerifiedReason:
                        type: boolean
                        example: false
                      canReceiveManualPayout:
                        type: boolean
                        example: true
                      needUpdateBanking:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999846
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49850
      tags:
        - Payouts
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Payout Requests (/api-reference/payouts/list-payout-requests)

List all payout requests for the account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/payouts/payout-requests
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/payouts/payout-requests:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Payout Requests
      operationId: listPayoutRequests
      description: List all payout requests for the account.
      parameters:
        - in: query
          name: limit
          description: Number of payout requests to return
          example: 10
          required: false
          schema:
            type: string
            description: Number of payout requests to return
            example: 10
        - in: query
          name: offset
          description: Number of payout requests to skip for pagination
          example: 0
          required: false
          schema:
            type: string
            description: Number of payout requests to skip for pagination
            example: 0
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - invoiceId: "123"
                        createdAt: 2025-01-01T01:01:01+00:00
                        amount: 123
                        currency: USD
                        state: new
                        rejectReason: null
                    marker: 123
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999844
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49848
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - invoiceId: "123"
                            createdAt: 2025-01-01T01:01:01+00:00
                            amount: 123
                            currency: USD
                            state: new
                            rejectReason: null
                        items:
                          type: object
                          properties:
                            invoiceId:
                              type: string
                              example: "123"
                            createdAt:
                              type: string
                              example: 2025-01-01T01:01:01+00:00
                            amount:
                              type: integer
                              example: 123
                            currency:
                              type: string
                              example: USD
                            state:
                              type: string
                              example: new
                            rejectReason:
                              type: string
                              example: null
                              nullable: true
                      marker:
                        type: integer
                        example: 123
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999844
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49848
      tags:
        - Payouts
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Request Manual Withdrawal (/api-reference/payouts/request-manual-withdrawal)

Request a payout withdrawal, if the frequency is set to manual. Refer to our `/payouts/balances` endpoint to retrieve the minimum and maximum withdrawal amounts.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/payouts/request-manual-withdrawal
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/payouts/request-manual-withdrawal:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Request Manual Withdrawal
      operationId: requestManualWithdrawal
      description: Request a payout withdrawal, if the frequency is set to manual.
        Refer to our `/payouts/balances` endpoint to retrieve the minimum and
        maximum withdrawal amounts.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                oneOf:
                  - description: ""
                    type: object
                    example:
                      data:
                        list:
                          - state: new
                            rejectReason: null
                      _meta:
                        _credits:
                          used: 1
                          balance: 1000000028
                          note: Always
                        _cache:
                          is_cached: false
                          note: Cache disabled for this endpoint
                        _rate_limits:
                          limit_minute: 10000000
                          limit_day: 50000
                          remaining_minute: 9999999
                          remaining_day: 49998
                    properties:
                      data:
                        type: object
                        properties:
                          list:
                            type: array
                            example:
                              - state: new
                                rejectReason: null
                            items:
                              type: object
                              properties:
                                state:
                                  type: string
                                  example: new
                                rejectReason:
                                  type: string
                                  example: null
                                  nullable: true
                      _meta:
                        type: object
                        properties:
                          _credits:
                            type: object
                            properties:
                              used:
                                type: integer
                                example: 1
                              balance:
                                type: integer
                                example: 1000000028
                              note:
                                type: string
                                example: Always
                          _cache:
                            type: object
                            properties:
                              is_cached:
                                type: boolean
                                example: false
                              note:
                                type: string
                                example: Cache disabled for this endpoint
                          _rate_limits:
                            type: object
                            properties:
                              limit_minute:
                                type: integer
                                example: 10000000
                              limit_day:
                                type: integer
                                example: 50000
                              remaining_minute:
                                type: integer
                                example: 9999999
                              remaining_day:
                                type: integer
                                example: 49998
                  - description: ""
                    type: object
                    example:
                      data:
                        list:
                          - state: new
                            rejectReason: null
                      _meta:
                        _credits:
                          used: 1
                          balance: 1000000028
                          note: Always
                        _cache:
                          is_cached: false
                          note: Cache disabled for this endpoint
                        _rate_limits:
                          limit_minute: 10000000
                          limit_day: 50000
                          remaining_minute: 9999999
                          remaining_day: 49998
                    properties:
                      data:
                        type: object
                        properties:
                          list:
                            type: array
                            example:
                              - state: new
                                rejectReason: null
                            items:
                              type: object
                              properties:
                                state:
                                  type: string
                                  example: new
                                rejectReason:
                                  type: string
                                  example: null
                                  nullable: true
                      _meta:
                        type: object
                        properties:
                          _credits:
                            type: object
                            properties:
                              used:
                                type: integer
                                example: 1
                              balance:
                                type: integer
                                example: 1000000028
                              note:
                                type: string
                                example: Always
                          _cache:
                            type: object
                            properties:
                              is_cached:
                                type: boolean
                                example: false
                              note:
                                type: string
                                example: Cache disabled for this endpoint
                          _rate_limits:
                            type: object
                            properties:
                              limit_minute:
                                type: integer
                                example: 10000000
                              limit_day:
                                type: integer
                                example: 50000
                              remaining_minute:
                                type: integer
                                example: 9999999
                              remaining_day:
                                type: integer
                                example: 49998
        "400":
          description: ""
          content:
            application/json:
              schema:
                oneOf:
                  - description: Not enough funds
                    type: object
                    example:
                      error: ONLYFANS_COM_ERROR
                      message: Bad Request - The request could not be understood by the server.
                      description: This error happened most probably because of a bug in the
                        OnlyFans.com API or you sent wrong parameters (like a
                        non-existing user id).
                      onlyfans_response:
                        status: 400
                        body:
                          error:
                            code: 0
                            message: Not enough funds to request a payout
                      _meta:
                        _credits:
                          used: 1
                          balance: 999999866
                          note: OnlyFans returned an error, but we still had to make an API request to
                            OnlyFans.com
                        _cache:
                          is_cached: false
                          note: Cache disabled for this endpoint
                        _rate_limits:
                          limit_minute: 10000000
                          limit_day: 50000
                          remaining_minute: 9999997
                          remaining_day: 49984
                    properties:
                      error:
                        type: string
                        example: ONLYFANS_COM_ERROR
                      message:
                        type: string
                        example: Bad Request - The request could not be understood by the server.
                      description:
                        type: string
                        example: This error happened most probably because of a bug in the OnlyFans.com
                          API or you sent wrong parameters (like a non-existing
                          user id).
                      onlyfans_response:
                        type: object
                        properties:
                          status:
                            type: integer
                            example: 400
                          body:
                            type: object
                            properties:
                              error:
                                type: object
                                properties:
                                  code:
                                    type: integer
                                    example: 0
                                  message:
                                    type: string
                                    example: Not enough funds to request a payout
                      _meta:
                        type: object
                        properties:
                          _credits:
                            type: object
                            properties:
                              used:
                                type: integer
                                example: 1
                              balance:
                                type: integer
                                example: 999999866
                              note:
                                type: string
                                example: OnlyFans returned an error, but we still had to make an API request to
                                  OnlyFans.com
                          _cache:
                            type: object
                            properties:
                              is_cached:
                                type: boolean
                                example: false
                              note:
                                type: string
                                example: Cache disabled for this endpoint
                          _rate_limits:
                            type: object
                            properties:
                              limit_minute:
                                type: integer
                                example: 10000000
                              limit_day:
                                type: integer
                                example: 50000
                              remaining_minute:
                                type: integer
                                example: 9999997
                              remaining_day:
                                type: integer
                                example: 49984
                  - description: Payout frequency is not set to manual
                    type: object
                    example:
                      error: ONLYFANS_COM_ERROR
                      message: Bad Request - The request could not be understood by the server due to
                        malformed syntax.
                      description: This error happened most probably because of a bug in the
                        OnlyFans.com API or you sent wrong parameters (like a
                        non-existing user id).
                      onlyfans_response:
                        status: 400
                        body:
                          error:
                            code: 0
                            message: Please contact support to resume payouts
                      _meta:
                        _credits:
                          used: 1
                          balance: 999999865
                          note: OnlyFans returned an error, but we still had to make an API request to
                            OnlyFans.com
                        _cache:
                          is_cached: false
                          note: Cache disabled for this endpoint
                        _rate_limits:
                          limit_minute: 10000000
                          limit_day: 50000
                          remaining_minute: 9999996
                          remaining_day: 49983
                    properties:
                      error:
                        type: string
                        example: ONLYFANS_COM_ERROR
                      message:
                        type: string
                        example: Bad Request - The request could not be understood by the server due to
                          malformed syntax.
                      description:
                        type: string
                        example: This error happened most probably because of a bug in the OnlyFans.com
                          API or you sent wrong parameters (like a non-existing
                          user id).
                      onlyfans_response:
                        type: object
                        properties:
                          status:
                            type: integer
                            example: 400
                          body:
                            type: object
                            properties:
                              error:
                                type: object
                                properties:
                                  code:
                                    type: integer
                                    example: 0
                                  message:
                                    type: string
                                    example: Please contact support to resume payouts
                      _meta:
                        type: object
                        properties:
                          _credits:
                            type: object
                            properties:
                              used:
                                type: integer
                                example: 1
                              balance:
                                type: integer
                                example: 999999865
                              note:
                                type: string
                                example: OnlyFans returned an error, but we still had to make an API request to
                                  OnlyFans.com
                          _cache:
                            type: object
                            properties:
                              is_cached:
                                type: boolean
                                example: false
                              note:
                                type: string
                                example: Cache disabled for this endpoint
                          _rate_limits:
                            type: object
                            properties:
                              limit_minute:
                                type: integer
                                example: 10000000
                              limit_day:
                                type: integer
                                example: 50000
                              remaining_minute:
                                type: integer
                                example: 9999996
                              remaining_day:
                                type: integer
                                example: 49983
      tags:
        - Payouts
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: integer
                  description: The amount to withdraw. Amount may not be higher than the current
                    balance.
                  example: 50
              required:
                - amount
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Update Payout Frequency (/api-reference/payouts/update-payout-frequency)

Update the payout frequency for the account (Manual, Weekly or Monthly).

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml patch /api/{account}/payouts/payout-frequency
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/payouts/payout-frequency:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    patch:
      summary: Update Payout Frequency
      operationId: updatePayoutFrequency
      description: Update the payout frequency for the account (Manual, Weekly or Monthly).
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999871
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999994
                      remaining_day: 49994
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999871
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999994
                          remaining_day:
                            type: integer
                            example: 49994
      tags:
        - Payouts
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                frequency:
                  type: string
                  description: The new payout frequency
                  example: manual
                  enum:
                    - manual
                    - weekly
                    - monthly
              required:
                - frequency
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Create Post Comment (/api-reference/post-comments/create-post-comment)

Create a comment on one of your posts.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/posts/{post_id}/comments
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/posts/{post_id}/comments:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: post_id
        description: The ID of the post.
        example: aliquid
        required: true
        schema:
          type: string
    post:
      summary: Create Post Comment
      operationId: createPostComment
      description: Create a comment on one of your posts.
      parameters:
        - in: query
          name: text
          description: The text of the comment.
          example: This is a comment.
          required: true
          schema:
            type: string
            description: The text of the comment.
            example: This is a comment.
        - in: query
          name: answerTo
          description: The ID of the comment to which this comment is a reply.
          example: 123
          required: false
          schema:
            type: integer
            description: The ID of the comment to which this comment is a reply.
            example: 123
        - in: query
          name: giphyId
          description: The ID of the Giphy to include in the comment.
          example: giphy123
          required: false
          schema:
            type: string
            description: The ID of the Giphy to include in the comment.
            example: giphy123
      responses:
        "201":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    text: Text
                    giphyId: null
                    author:
                      view: s
                      avatar: https://public.onlyfans.com/files/.../avatar.jpg
                      avatarThumbs:
                        c50: https://thumbs.onlyfans.com/public/files/thumbs/.../avatar.jpg
                        c144: https://thumbs.onlyfans.com/public/files/thumbs/.../avatar.jpg
                      header: https://public.onlyfans.com/files/.../header_image.jpg
                      headerSize:
                        width: 4032
                        height: 3024
                      headerThumbs:
                        w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/.../header_image.jpg
                        w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/.../header_image.jpg
                      id: 123
                      name: Name
                      username: username
                      canLookStory: true
                      canCommentStory: true
                      hasNotViewedStory: false
                      isVerified: true
                      canPayInternal: true
                      hasScheduledStream: false
                      hasStream: false
                      hasStories: false
                      tipsEnabled: true
                      tipsTextEnabled: true
                      tipsMin: 5
                      tipsMinInternal: 1
                      tipsMax: 200
                      canEarn: true
                      canAddSubscriber: false
                      subscribePrice: 4.99
                      hasStripe: false
                      isStripeExist: false
                      subscriptionBundles: []
                      canSendChatToAll: true
                      creditsMin: 10
                      creditsMax: 200
                      isPaywallPassed: true
                      creditsMinAlternatives: 5
                      canCreateLists: true
                      showMediaCount: true
                      lastSeen: 2025-01-01T00:00:00+00:00
                      canReport: false
                      subscribedOn: null
                    canLike: true
                    likesCount: 0
                    isLiked: false
                    isLikedByAuthor: false
                    postedAt: 2025-01-01T00:00:00+00:00
                    changedAt: 2025-01-01T00:00:00+00:00
                    isPinned: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999852
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 996
                      remaining_day: 49857
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      text:
                        type: string
                        example: Text
                      giphyId:
                        type: string
                        example: null
                        nullable: true
                      author:
                        type: object
                        properties:
                          view:
                            type: string
                            example: s
                          avatar:
                            type: string
                            example: https://public.onlyfans.com/files/.../avatar.jpg
                          avatarThumbs:
                            type: object
                            properties:
                              c50:
                                type: string
                                example: https://thumbs.onlyfans.com/public/files/thumbs/.../avatar.jpg
                              c144:
                                type: string
                                example: https://thumbs.onlyfans.com/public/files/thumbs/.../avatar.jpg
                          header:
                            type: string
                            example: https://public.onlyfans.com/files/.../header_image.jpg
                          headerSize:
                            type: object
                            properties:
                              width:
                                type: integer
                                example: 4032
                              height:
                                type: integer
                                example: 3024
                          headerThumbs:
                            type: object
                            properties:
                              w480:
                                type: string
                                example: https://thumbs.onlyfans.com/public/files/thumbs/w480/.../header_image.jpg
                              w760:
                                type: string
                                example: https://thumbs.onlyfans.com/public/files/thumbs/w760/.../header_image.jpg
                          id:
                            type: integer
                            example: 123
                          name:
                            type: string
                            example: Name
                          username:
                            type: string
                            example: username
                          canLookStory:
                            type: boolean
                            example: true
                          canCommentStory:
                            type: boolean
                            example: true
                          hasNotViewedStory:
                            type: boolean
                            example: false
                          isVerified:
                            type: boolean
                            example: true
                          canPayInternal:
                            type: boolean
                            example: true
                          hasScheduledStream:
                            type: boolean
                            example: false
                          hasStream:
                            type: boolean
                            example: false
                          hasStories:
                            type: boolean
                            example: false
                          tipsEnabled:
                            type: boolean
                            example: true
                          tipsTextEnabled:
                            type: boolean
                            example: true
                          tipsMin:
                            type: integer
                            example: 5
                          tipsMinInternal:
                            type: integer
                            example: 1
                          tipsMax:
                            type: integer
                            example: 200
                          canEarn:
                            type: boolean
                            example: true
                          canAddSubscriber:
                            type: boolean
                            example: false
                          subscribePrice:
                            type: number
                            example: 4.99
                          hasStripe:
                            type: boolean
                            example: false
                          isStripeExist:
                            type: boolean
                            example: false
                          subscriptionBundles:
                            type: array
                            example: []
                          canSendChatToAll:
                            type: boolean
                            example: true
                          creditsMin:
                            type: integer
                            example: 10
                          creditsMax:
                            type: integer
                            example: 200
                          isPaywallPassed:
                            type: boolean
                            example: true
                          creditsMinAlternatives:
                            type: integer
                            example: 5
                          canCreateLists:
                            type: boolean
                            example: true
                          showMediaCount:
                            type: boolean
                            example: true
                          lastSeen:
                            type: string
                            example: 2025-01-01T00:00:00+00:00
                          canReport:
                            type: boolean
                            example: false
                          subscribedOn:
                            type: string
                            example: null
                            nullable: true
                      canLike:
                        type: boolean
                        example: true
                      likesCount:
                        type: integer
                        example: 0
                      isLiked:
                        type: boolean
                        example: false
                      isLikedByAuthor:
                        type: boolean
                        example: false
                      postedAt:
                        type: string
                        example: 2025-01-01T00:00:00+00:00
                      changedAt:
                        type: string
                        example: 2025-01-01T00:00:00+00:00
                      isPinned:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999852
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 996
                          remaining_day:
                            type: integer
                            example: 49857
      tags:
        - Post Comments
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Delete Post Comment (/api-reference/post-comments/delete-post-comment)

Delete a comment on one of your posts.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/posts/{post_id}/comments/{comment_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/posts/{post_id}/comments/{comment_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: post_id
        description: The ID of the post to which the comment belongs.
        example: 123
        required: true
        schema:
          type: integer
      - in: path
        name: comment_id
        description: The ID of the comment to delete.
        example: 123
        required: true
        schema:
          type: integer
    delete:
      summary: Delete Post Comment
      operationId: deletePostComment
      description: Delete a comment on one of your posts.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999865
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 997
                      remaining_day: 49872
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999865
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 49872
      tags:
        - Post Comments
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Like Post Comment (/api-reference/post-comments/like-post-comment)

Like a comment on one of your posts.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/posts/{post_id}/comments/{comment_id}/like
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/posts/{post_id}/comments/{comment_id}/like:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: post_id
        description: The ID of the post to which the comment belongs.
        example: 123
        required: true
        schema:
          type: integer
      - in: path
        name: comment_id
        description: The ID of the comment to like.
        example: 123
        required: true
        schema:
          type: integer
    post:
      summary: Like Post Comment
      operationId: likePostComment
      description: Like a comment on one of your posts.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                    isLiked: true
                    likesCount: 1
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999863
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 995
                      remaining_day: 49870
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                      isLiked:
                        type: boolean
                        example: true
                      likesCount:
                        type: integer
                        example: 1
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999863
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 995
                          remaining_day:
                            type: integer
                            example: 49870
      tags:
        - Post Comments
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Post Comments (/api-reference/post-comments/list-post-comments)

Get comments from one of your posts.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/posts/{post_id}/comments
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/posts/{post_id}/comments:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: post_id
        description: The ID of the post.
        example: aliquid
        required: true
        schema:
          type: string
    get:
      summary: List Post Comments
      operationId: listPostComments
      description: Get comments from one of your posts.
      parameters:
        - in: query
          name: limit
          description: Number of comments to return (default = 10)
          example: 10
          required: false
          schema:
            type: integer
            description: Number of comments to return (default = 10)
            example: 10
        - in: query
          name: offset
          description: Number of comments to skip for pagination
          example: 0
          required: false
          schema:
            type: integer
            description: Number of comments to skip for pagination
            example: 0
        - in: query
          name: sort
          description: Sort the returned comments (default = desc)
          example: desc
          required: false
          schema:
            type: string
            description: Sort the returned comments (default = desc)
            example: desc
            enum:
              - desc
              - asc
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - id: 123
                        text: Text
                        giphyId: null
                        author:
                          id: 123
                          _view: s
                        canLike: true
                        likesCount: 0
                        isLiked: false
                        isLikedByAuthor: false
                        postedAt: 2025-01-01T00:00:00+00:00
                        changedAt: 2025-01-01T00:00:00+00:00
                        isPinned: false
                    hasMore: false
                    nextOffset: 1
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999876
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49883
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - id: 123
                            text: Text
                            giphyId: null
                            author:
                              id: 123
                              _view: s
                            canLike: true
                            likesCount: 0
                            isLiked: false
                            isLikedByAuthor: false
                            postedAt: 2025-01-01T00:00:00+00:00
                            changedAt: 2025-01-01T00:00:00+00:00
                            isPinned: false
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            text:
                              type: string
                              example: Text
                            giphyId:
                              type: string
                              example: null
                              nullable: true
                            author:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                _view:
                                  type: string
                                  example: s
                            canLike:
                              type: boolean
                              example: true
                            likesCount:
                              type: integer
                              example: 0
                            isLiked:
                              type: boolean
                              example: false
                            isLikedByAuthor:
                              type: boolean
                              example: false
                            postedAt:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            changedAt:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            isPinned:
                              type: boolean
                              example: false
                      hasMore:
                        type: boolean
                        example: false
                      nextOffset:
                        type: integer
                        example: 1
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999876
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49883
      tags:
        - Post Comments
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Pin Post Comment (/api-reference/post-comments/pin-post-comment)

Pin a comment on one of your posts.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/posts/{post_id}/comments/{comment_id}/pin
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/posts/{post_id}/comments/{comment_id}/pin:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: post_id
        description: The ID of the post to which the comment belongs.
        example: 123
        required: true
        schema:
          type: integer
      - in: path
        name: comment_id
        description: The ID of the comment to pin.
        example: 123
        required: true
        schema:
          type: integer
    post:
      summary: Pin Post Comment
      operationId: pinPostComment
      description: Pin a comment on one of your posts.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999858
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49865
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999858
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49865
      tags:
        - Post Comments
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Unlike Post Comment (/api-reference/post-comments/unlike-post-comment)

Unlike a comment on one of your posts.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/posts/{post_id}/comments/{comment_id}/like
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/posts/{post_id}/comments/{comment_id}/like:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: post_id
        description: The ID of the post to which the comment belongs.
        example: 123
        required: true
        schema:
          type: integer
      - in: path
        name: comment_id
        description: The ID of the comment to like.
        example: 123
        required: true
        schema:
          type: integer
    delete:
      summary: Unlike Post Comment
      operationId: unlikePostComment
      description: Unlike a comment on one of your posts.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                    isLiked: false
                    likesCount: 1
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999862
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49869
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                      isLiked:
                        type: boolean
                        example: false
                      likesCount:
                        type: integer
                        example: 1
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999862
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49869
      tags:
        - Post Comments
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Unpin Post Comment (/api-reference/post-comments/unpin-post-comment)

Unpin a comment from one of your posts.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/posts/{post_id}/comments/{comment_id}/pin
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/posts/{post_id}/comments/{comment_id}/pin:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: post_id
        description: The ID of the post to which the comment belongs.
        example: 123
        required: true
        schema:
          type: integer
      - in: path
        name: comment_id
        description: The ID of the comment to pin.
        example: 123
        required: true
        schema:
          type: integer
    delete:
      summary: Unpin Post Comment
      operationId: unpinPostComment
      description: Unpin a comment from one of your posts.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999857
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49864
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999857
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49864
      tags:
        - Post Comments
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Archive Post (/api-reference/posts/archive-post)

Archive a post from your account. Also can be used to move posts between the Regular and Private Archive.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/posts/{post_id}/archive
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/posts/{post_id}/archive:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: post_id
        description: The ID of the post
        example: 1234567890
        required: true
        schema:
          type: integer
    post:
      summary: Archive Post
      operationId: archivePost
      description: Archive a post from your account. Also can be used to move posts
        between the Regular and Private Archive.
      parameters:
        - in: query
          name: private_archive
          description: Set to `true` to move this post to the Private Archive.
          example: true
          required: false
          schema:
            type: boolean
            description: Set to `true` to move this post to the Private Archive.
            example: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    labelStates:
                      - id: private_archived
                        name: Private Archive
                        type: private_archived
                        isClearInProgress: false
                        postsCount: 0
                        posts: []
                      - id: archived
                        name: Archive
                        type: archived
                        isClearInProgress: false
                        postsCount: 1
                        posts:
                          - type: text
                            canViewMedia: true
                            postId: 1791158283
                    counters:
                      audiosCount: 0
                      photosCount: 0
                      videosCount: 0
                      mediasCount: 0
                      postsCount: 1
                      streamsCount: 0
                      archivedPostsCount: 1
                      privateArchivedPostsCount: 0
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999901
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49917
                properties:
                  data:
                    type: object
                    properties:
                      labelStates:
                        type: array
                        example:
                          - id: private_archived
                            name: Private Archive
                            type: private_archived
                            isClearInProgress: false
                            postsCount: 0
                            posts: []
                          - id: archived
                            name: Archive
                            type: archived
                            isClearInProgress: false
                            postsCount: 1
                            posts:
                              - type: text
                                canViewMedia: true
                                postId: 1791158283
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: private_archived
                            name:
                              type: string
                              example: Private Archive
                            type:
                              type: string
                              example: private_archived
                            isClearInProgress:
                              type: boolean
                              example: false
                            postsCount:
                              type: integer
                              example: 0
                            posts:
                              type: array
                              example: []
                      counters:
                        type: object
                        properties:
                          audiosCount:
                            type: integer
                            example: 0
                          photosCount:
                            type: integer
                            example: 0
                          videosCount:
                            type: integer
                            example: 0
                          mediasCount:
                            type: integer
                            example: 0
                          postsCount:
                            type: integer
                            example: 1
                          streamsCount:
                            type: integer
                            example: 0
                          archivedPostsCount:
                            type: integer
                            example: 1
                          privateArchivedPostsCount:
                            type: integer
                            example: 0
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999901
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49917
      tags:
        - Posts
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Delete Post (/api-reference/posts/delete-post)

Delete a post from your account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/posts/{post_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/posts/{post_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: post_id
        description: The ID of the post
        example: 1234567890
        required: true
        schema:
          type: integer
    delete:
      summary: Delete Post
      operationId: deletePost
      description: Delete a post from your account.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                    counters:
                      audiosCount: 123
                      photosCount: 123
                      videosCount: 123
                      mediasCount: 123
                      postsCount: 123
                      streamsCount: 123
                      archivedPostsCount: 123
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999989
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49987
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                      counters:
                        type: object
                        properties:
                          audiosCount:
                            type: integer
                            example: 123
                          photosCount:
                            type: integer
                            example: 123
                          videosCount:
                            type: integer
                            example: 123
                          mediasCount:
                            type: integer
                            example: 123
                          postsCount:
                            type: integer
                            example: 123
                          streamsCount:
                            type: integer
                            example: 123
                          archivedPostsCount:
                            type: integer
                            example: 123
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999989
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49987
      tags:
        - Posts
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Post (/api-reference/posts/get-post)

Retrieve details of a post from your account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/posts/{post_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/posts/{post_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: post_id
        description: The ID of the post
        example: 1234567890
        required: true
        schema:
          type: integer
    get:
      summary: Get Post
      operationId: getPost
      description: Retrieve details of a post from your account.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    author:
                      view: a
                      avatar: https://public.onlyfans.com/files/w/w6/w6g/.../123/avatar.jpg
                      avatarThumbs:
                        c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/w/w6/w6g/.../123/avatar.jpg
                        c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/w/w6/w6g/.../123/avatar.jpg
                      header: https://public.onlyfans.com/files/k/kk/kk6/.../123/header_image.jpg
                      headerSize:
                        width: 760
                        height: 570
                      headerThumbs:
                        w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/k/kk/kk6/.../123/header_image.jpg
                        w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/k/kk/kk6/.../123/header_image.jpg
                      id: 123
                      name: name
                      username: username
                      canLookStory: true
                      canCommentStory: true
                      hasNotViewedStory: false
                      isVerified: true
                      canPayInternal: true
                      hasScheduledStream: false
                      hasStream: false
                      hasStories: false
                      tipsEnabled: true
                      tipsTextEnabled: true
                      tipsMin: 5
                      tipsMinInternal: 1
                      tipsMax: 200
                      canEarn: true
                      canAddSubscriber: false
                      subscribePrice: 0
                      hasStripe: false
                      isStripeExist: false
                      subscriptionBundles: []
                      canSendChatToAll: true
                      creditsMin: 10
                      creditsMax: 200
                      isPaywallPassed: true
                      canCreateLists: true
                      showMediaCount: true
                      showPostsInFeed: true
                      subscribedBy: true
                      canTrialSend: false
                    responseType: post
                    id: 123
                    postedAt: 2025-01-01T01:01:01+00:00
                    postedAtPrecise: "123.000000"
                    text: <p>Post text</p>
                    isMarkdownDisabled: true
                    canDelete: true
                    canComment: true
                    canEdit: true
                    isMediaReady: true
                    isOpened: true
                    canToggleFavorite: true
                    canEditText: true
                    tipsAmount: $0
                    rawText: Post text
                    canViewMedia: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999836
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999998
                      remaining_day: 49994
                properties:
                  data:
                    type: object
                    properties:
                      author:
                        type: object
                        properties:
                          view:
                            type: string
                            example: a
                          avatar:
                            type: string
                            example: https://public.onlyfans.com/files/w/w6/w6g/.../123/avatar.jpg
                          avatarThumbs:
                            type: object
                            properties:
                              c50:
                                type: string
                                example: https://thumbs.onlyfans.com/public/files/thumbs/c50/w/w6/w6g/.../123/avatar.jpg
                              c144:
                                type: string
                                example: https://thumbs.onlyfans.com/public/files/thumbs/c144/w/w6/w6g/.../123/avatar.jpg
                          header:
                            type: string
                            example: https://public.onlyfans.com/files/k/kk/kk6/.../123/header_image.jpg
                          headerSize:
                            type: object
                            properties:
                              width:
                                type: integer
                                example: 760
                              height:
                                type: integer
                                example: 570
                          headerThumbs:
                            type: object
                            properties:
                              w480:
                                type: string
                                example: https://thumbs.onlyfans.com/public/files/thumbs/w480/k/kk/kk6/.../123/header_image.jpg
                              w760:
                                type: string
                                example: https://thumbs.onlyfans.com/public/files/thumbs/w760/k/kk/kk6/.../123/header_image.jpg
                          id:
                            type: integer
                            example: 123
                          name:
                            type: string
                            example: name
                          username:
                            type: string
                            example: username
                          canLookStory:
                            type: boolean
                            example: true
                          canCommentStory:
                            type: boolean
                            example: true
                          hasNotViewedStory:
                            type: boolean
                            example: false
                          isVerified:
                            type: boolean
                            example: true
                          canPayInternal:
                            type: boolean
                            example: true
                          hasScheduledStream:
                            type: boolean
                            example: false
                          hasStream:
                            type: boolean
                            example: false
                          hasStories:
                            type: boolean
                            example: false
                          tipsEnabled:
                            type: boolean
                            example: true
                          tipsTextEnabled:
                            type: boolean
                            example: true
                          tipsMin:
                            type: integer
                            example: 5
                          tipsMinInternal:
                            type: integer
                            example: 1
                          tipsMax:
                            type: integer
                            example: 200
                          canEarn:
                            type: boolean
                            example: true
                          canAddSubscriber:
                            type: boolean
                            example: false
                          subscribePrice:
                            type: integer
                            example: 0
                          hasStripe:
                            type: boolean
                            example: false
                          isStripeExist:
                            type: boolean
                            example: false
                          subscriptionBundles:
                            type: array
                            example: []
                          canSendChatToAll:
                            type: boolean
                            example: true
                          creditsMin:
                            type: integer
                            example: 10
                          creditsMax:
                            type: integer
                            example: 200
                          isPaywallPassed:
                            type: boolean
                            example: true
                          canCreateLists:
                            type: boolean
                            example: true
                          showMediaCount:
                            type: boolean
                            example: true
                          showPostsInFeed:
                            type: boolean
                            example: true
                          subscribedBy:
                            type: boolean
                            example: true
                          canTrialSend:
                            type: boolean
                            example: false
                      responseType:
                        type: string
                        example: post
                      id:
                        type: integer
                        example: 123
                      postedAt:
                        type: string
                        example: 2025-01-01T01:01:01+00:00
                      postedAtPrecise:
                        type: string
                        example: "123.000000"
                      text:
                        type: string
                        example: <p>Post text</p>
                      isMarkdownDisabled:
                        type: boolean
                        example: true
                      canDelete:
                        type: boolean
                        example: true
                      canComment:
                        type: boolean
                        example: true
                      canEdit:
                        type: boolean
                        example: true
                      isMediaReady:
                        type: boolean
                        example: true
                      isOpened:
                        type: boolean
                        example: true
                      canToggleFavorite:
                        type: boolean
                        example: true
                      canEditText:
                        type: boolean
                        example: true
                      tipsAmount:
                        type: string
                        example: $0
                      rawText:
                        type: string
                        example: Post text
                      canViewMedia:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999836
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999998
                          remaining_day:
                            type: integer
                            example: 49994
      tags:
        - Posts
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Posts (/api-reference/posts/list-posts)

Get posts from your OnlyFans account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/posts
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/posts:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Posts
      operationId: listPosts
      description: Get posts from your OnlyFans account.
      parameters:
        - in: query
          name: query
          description: Search query to filter posts
          example: Hello
          required: false
          schema:
            type: string
            description: Search query to filter posts
            example: Hello
        - in: query
          name: limit
          description: Number of posts to return (default = 10)
          example: 10
          required: false
          schema:
            type: integer
            description: Number of posts to return (default = 10)
            example: 10
        - in: query
          name: offset
          description: Number of posts to skip for pagination
          example: 0
          required: false
          schema:
            type: integer
            description: Number of posts to skip for pagination
            example: 0
        - in: query
          name: order
          description: Order the returned posts (default = publish_date)
          example: publish_date
          required: false
          schema:
            type: string
            description: Order the returned posts (default = publish_date)
            example: publish_date
            enum:
              - publish_date
              - favorites_count
              - tips_summ
        - in: query
          name: sort
          description: Sort the returned posts (default = desc)
          example: desc
          required: false
          schema:
            type: string
            description: Sort the returned posts (default = desc)
            example: desc
            enum:
              - desc
              - asc
        - in: query
          name: pinned
          description: Set to true to only show pinned posts
          example: true
          required: false
          schema:
            type: boolean
            description: Set to true to only show pinned posts
            example: true
        - in: query
          name: counters
          description: Set to true to include an array of counters (see example responses)
          example: true
          required: false
          schema:
            type: boolean
            description: Set to true to include an array of counters (see example responses)
            example: true
        - in: query
          name: minimumPublishDate
          description: Filter posts by minimum publish date
          example: 2025-06-26
          required: false
          schema:
            type: string
            description: Filter posts by minimum publish date
            example: 2025-06-26
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - author:
                          id: 123
                          _view: a
                        responseType: post
                        id: 123
                        postedAt: 2025-01-01T01:01:01+00:00
                        postedAtPrecise: "1234567890.000000"
                        text: <p>Text</p>
                        isMarkdownDisabled: true
                        canDelete: true
                        canComment: true
                        canEdit: true
                        isMediaReady: true
                        isOpened: true
                        canToggleFavorite: true
                        tipsAmount: $0
                        rawText: Text
                        canViewMedia: true
                    hasMore: false
                    headMarker: "1234567890.000000"
                    tailMarker: "1234567890.000000"
                    counters:
                      audiosCount: 123
                      photosCount: 123
                      videosCount: 123
                      mediasCount: 123
                      postsCount: 123
                      streamsCount: 123
                      archivedPostsCount: 123
                      privateArchivedPostsCount: 123
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999886
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49896
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - author:
                              id: 123
                              _view: a
                            responseType: post
                            id: 123
                            postedAt: 2025-01-01T01:01:01+00:00
                            postedAtPrecise: "1234567890.000000"
                            text: <p>Text</p>
                            isMarkdownDisabled: true
                            canDelete: true
                            canComment: true
                            canEdit: true
                            isMediaReady: true
                            isOpened: true
                            canToggleFavorite: true
                            tipsAmount: $0
                            rawText: Text
                            canViewMedia: true
                        items:
                          type: object
                          properties:
                            author:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                _view:
                                  type: string
                                  example: a
                            responseType:
                              type: string
                              example: post
                            id:
                              type: integer
                              example: 123
                            postedAt:
                              type: string
                              example: 2025-01-01T01:01:01+00:00
                            postedAtPrecise:
                              type: string
                              example: "1234567890.000000"
                            text:
                              type: string
                              example: <p>Text</p>
                            isMarkdownDisabled:
                              type: boolean
                              example: true
                            canDelete:
                              type: boolean
                              example: true
                            canComment:
                              type: boolean
                              example: true
                            canEdit:
                              type: boolean
                              example: true
                            isMediaReady:
                              type: boolean
                              example: true
                            isOpened:
                              type: boolean
                              example: true
                            canToggleFavorite:
                              type: boolean
                              example: true
                            tipsAmount:
                              type: string
                              example: $0
                            rawText:
                              type: string
                              example: Text
                            canViewMedia:
                              type: boolean
                              example: true
                      hasMore:
                        type: boolean
                        example: false
                      headMarker:
                        type: string
                        example: "1234567890.000000"
                      tailMarker:
                        type: string
                        example: "1234567890.000000"
                      counters:
                        type: object
                        properties:
                          audiosCount:
                            type: integer
                            example: 123
                          photosCount:
                            type: integer
                            example: 123
                          videosCount:
                            type: integer
                            example: 123
                          mediasCount:
                            type: integer
                            example: 123
                          postsCount:
                            type: integer
                            example: 123
                          streamsCount:
                            type: integer
                            example: 123
                          archivedPostsCount:
                            type: integer
                            example: 123
                          privateArchivedPostsCount:
                            type: integer
                            example: 123
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999886
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49896
      tags:
        - Posts
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Pin/Unpin Post (/api-reference/posts/pin-unpin-post)

Pin or unpin a post to your account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/posts/{post_id}/pin
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/posts/{post_id}/pin:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: post_id
        description: The ID of the post
        example: 1234567890
        required: true
        schema:
          type: integer
    post:
      summary: Pin/Unpin Post
      operationId: pinUnpinPost
      description: Pin or unpin a post to your account.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999883
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49892
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999883
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49892
      tags:
        - Posts
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Send Post (/api-reference/posts/send-post)

Compose and send a new post to your OnlyFans account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/posts
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/posts:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Send Post
      operationId: sendPost
      description: Compose and send a new post to your OnlyFans account.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    author:
                      view: a
                      avatar: https://public.onlyfans.com/files/.../avatar.jpg
                      avatarThumbs:
                        c50: https://thumbs.onlyfans.com/public/files/thumbs/.../avatar.jpg
                        c144: https://thumbs.onlyfans.com/public/files/thumbs/.../avatar.jpg
                      header: https://public.onlyfans.com/files/.../header_image.jpg
                      headerSize:
                        width: 4032
                        height: 3024
                      headerThumbs:
                        w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/.../header_image.jpg
                        w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/.../header_image.jpg
                      id: 123
                      name: Name
                      username: username
                      canLookStory: true
                      canCommentStory: true
                      hasNotViewedStory: false
                      isVerified: true
                      canPayInternal: true
                      hasScheduledStream: false
                      hasStream: false
                      hasStories: false
                      tipsEnabled: false
                      tipsTextEnabled: true
                      tipsMin: 5
                      tipsMinInternal: 1
                      tipsMax: 200
                      canEarn: true
                      canAddSubscriber: false
                      subscribePrice: 4.99
                      hasStripe: false
                      isStripeExist: false
                      subscriptionBundles: []
                      canSendChatToAll: true
                      creditsMin: 10
                      creditsMax: 200
                      isPaywallPassed: true
                      canCreateLists: true
                      showMediaCount: true
                      showPostsInFeed: true
                      subscribedBy: true
                      canTrialSend: false
                    responseType: post
                    id: 123
                    postedAt: 2025-01-01T01:01:01+00:00
                    postedAtPrecise: "123.000000"
                    text: Text
                    isMarkdownDisabled: true
                    canDelete: true
                    canComment: true
                    canEdit: true
                    mediaCount: 1
                    isOpened: true
                    canToggleFavorite: true
                    tipsAmount: $0
                    rawText: Text
                    media:
                      - id: 123
                        type: photo
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: 2025-01-01T00:00:00+00:00
                        isReady: false
                        files:
                          full:
                            url: null
                            width: 0
                            height: 0
                            size: 0
                            sources: []
                          thumb: null
                          preview: null
                          squarePreview: null
                        duration: 0
                        releaseForms: []
                        hasCustomPreview: false
                    canViewMedia: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999991
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49990
                properties:
                  data:
                    type: object
                    properties:
                      author:
                        type: object
                        properties:
                          view:
                            type: string
                            example: a
                          avatar:
                            type: string
                            example: https://public.onlyfans.com/files/.../avatar.jpg
                          avatarThumbs:
                            type: object
                            properties:
                              c50:
                                type: string
                                example: https://thumbs.onlyfans.com/public/files/thumbs/.../avatar.jpg
                              c144:
                                type: string
                                example: https://thumbs.onlyfans.com/public/files/thumbs/.../avatar.jpg
                          header:
                            type: string
                            example: https://public.onlyfans.com/files/.../header_image.jpg
                          headerSize:
                            type: object
                            properties:
                              width:
                                type: integer
                                example: 4032
                              height:
                                type: integer
                                example: 3024
                          headerThumbs:
                            type: object
                            properties:
                              w480:
                                type: string
                                example: https://thumbs.onlyfans.com/public/files/thumbs/w480/.../header_image.jpg
                              w760:
                                type: string
                                example: https://thumbs.onlyfans.com/public/files/thumbs/w760/.../header_image.jpg
                          id:
                            type: integer
                            example: 123
                          name:
                            type: string
                            example: Name
                          username:
                            type: string
                            example: username
                          canLookStory:
                            type: boolean
                            example: true
                          canCommentStory:
                            type: boolean
                            example: true
                          hasNotViewedStory:
                            type: boolean
                            example: false
                          isVerified:
                            type: boolean
                            example: true
                          canPayInternal:
                            type: boolean
                            example: true
                          hasScheduledStream:
                            type: boolean
                            example: false
                          hasStream:
                            type: boolean
                            example: false
                          hasStories:
                            type: boolean
                            example: false
                          tipsEnabled:
                            type: boolean
                            example: false
                          tipsTextEnabled:
                            type: boolean
                            example: true
                          tipsMin:
                            type: integer
                            example: 5
                          tipsMinInternal:
                            type: integer
                            example: 1
                          tipsMax:
                            type: integer
                            example: 200
                          canEarn:
                            type: boolean
                            example: true
                          canAddSubscriber:
                            type: boolean
                            example: false
                          subscribePrice:
                            type: number
                            example: 4.99
                          hasStripe:
                            type: boolean
                            example: false
                          isStripeExist:
                            type: boolean
                            example: false
                          subscriptionBundles:
                            type: array
                            example: []
                          canSendChatToAll:
                            type: boolean
                            example: true
                          creditsMin:
                            type: integer
                            example: 10
                          creditsMax:
                            type: integer
                            example: 200
                          isPaywallPassed:
                            type: boolean
                            example: true
                          canCreateLists:
                            type: boolean
                            example: true
                          showMediaCount:
                            type: boolean
                            example: true
                          showPostsInFeed:
                            type: boolean
                            example: true
                          subscribedBy:
                            type: boolean
                            example: true
                          canTrialSend:
                            type: boolean
                            example: false
                      responseType:
                        type: string
                        example: post
                      id:
                        type: integer
                        example: 123
                      postedAt:
                        type: string
                        example: 2025-01-01T01:01:01+00:00
                      postedAtPrecise:
                        type: string
                        example: "123.000000"
                      text:
                        type: string
                        example: Text
                      isMarkdownDisabled:
                        type: boolean
                        example: true
                      canDelete:
                        type: boolean
                        example: true
                      canComment:
                        type: boolean
                        example: true
                      canEdit:
                        type: boolean
                        example: true
                      mediaCount:
                        type: integer
                        example: 1
                      isOpened:
                        type: boolean
                        example: true
                      canToggleFavorite:
                        type: boolean
                        example: true
                      tipsAmount:
                        type: string
                        example: $0
                      rawText:
                        type: string
                        example: Text
                      media:
                        type: array
                        example:
                          - id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: 2025-01-01T00:00:00+00:00
                            isReady: false
                            files:
                              full:
                                url: null
                                width: 0
                                height: 0
                                size: 0
                                sources: []
                              thumb: null
                              preview: null
                              squarePreview: null
                            duration: 0
                            releaseForms: []
                            hasCustomPreview: false
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            type:
                              type: string
                              example: photo
                            convertedToVideo:
                              type: boolean
                              example: false
                            canView:
                              type: boolean
                              example: true
                            hasError:
                              type: boolean
                              example: false
                            createdAt:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            isReady:
                              type: boolean
                              example: false
                            files:
                              type: object
                              properties:
                                full:
                                  type: object
                                  properties:
                                    url:
                                      type: string
                                      example: null
                                      nullable: true
                                    width:
                                      type: integer
                                      example: 0
                                    height:
                                      type: integer
                                      example: 0
                                    size:
                                      type: integer
                                      example: 0
                                    sources:
                                      type: array
                                      example: []
                                thumb:
                                  type: string
                                  example: null
                                  nullable: true
                                preview:
                                  type: string
                                  example: null
                                  nullable: true
                                squarePreview:
                                  type: string
                                  example: null
                                  nullable: true
                            duration:
                              type: integer
                              example: 0
                            releaseForms:
                              type: array
                              example: []
                            hasCustomPreview:
                              type: boolean
                              example: false
                      canViewMedia:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999991
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49990
      tags:
        - Posts
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: The post text content
                  example: Hello!
                labelIds:
                  type: string
                  description: Array of OF label IDs. Refer to our `/posts/labels` endpoint.
                  example:
                    - 123
                mediaFiles:
                  type: array
                  description: Direct file uploads, OFAPI `ofapi_media_` IDs, or OF vault IDs.
                  example:
                    - ofapi_media_abc123
                    - "1234567890"
                  items:
                    type: file[]|string
                previews:
                  type: array
                  description: Direct file uploads, OFAPI `ofapi_media_` IDs, OF vault IDs, or
                    integer indices referencing uploaded files in `mediaFiles`.
                    Will be shown if `price` is provided.
                  example:
                    - ofapi_media_abc123
                    - 1234567890
                  items:
                    type: file[]|string[]|int
                rfTag:
                  type: string
                  description: Array OnlyFans creator user IDs to tag in your post
                  example:
                    - 123
                expireDays:
                  type: integer
                  description: Number of days after which the post will expire. Between 1 and 30
                    days. Keep empty for no expiration.
                  example: 3
                scheduledDate:
                  type: string
                  description: Schedule your post in the future (UTC timezone).
                  example: 2025-01-01T00:00:00.000Z
                saveForLater:
                  type: boolean
                  description: Add your post to the "Saved for later" queue.
                  example: true
                fundRaisingTargetAmount:
                  type: integer
                  description: Add a fundraising target to your post. If present, value must be at
                    least 10.
                  example: 30
                fundRaisingTipsPresets:
                  type: array
                  description: Specify which tip amounts will be listed under the fundraising
                    card. Required with `fundRaisingTargetAmount`, and you must
                    provide at least 1 option. Array items cannot be higher than
                    the `fundRaisingTargetAmount`.
                  example:
                    - 5
                    - 10
                    - 15
                  items:
                    type: string
                votingType:
                  type: string
                  description: Include a poll or quiz within your post.
                  example: poll
                  enum:
                    - poll
                    - quiz
                votingDue:
                  type: integer
                  description: The due date (in days) of your poll/quiz. Can be 1, 3, 7 or 30
                    days. Can only be filled with `votingType`.
                  example: 3
                votingOptions:
                  type: array
                  description: The options of your poll/quiz. Required with `votingType`.
                  example:
                    - First option
                    - Second option
                  items:
                    type: string
                votingCorrectIndex:
                  type: integer
                  description: The array key of your quiz' correct answer. Required when
                    `votingType` is "quiz". Keep in mind that arrays start at
                    `0`
                  example: 0
                blockBannedWords:
                  type: string
                  description: Screen `text` for OnlyFans banned words and block the post if any
                    are found (returns a 422 listing the offending words).
                    `strict_ban` blocks all tiers, `risky` blocks Risky +
                    Replace/soften, `replace_soften` blocks Replace/soften only.
                    Omit to disable screening.
                  example: strict_ban
                  enum:
                    - strict_ban
                    - risky
                    - replace_soften
              required:
                - text
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Show Post Statistics (/api-reference/posts/show-post-statistics)

Show the statistics of a post like purchases, views, likes, tips and more.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/posts/{post_id}/stats
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/posts/{post_id}/stats:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: post_id
        description: The ID of the post
        example: 1234567890
        required: true
        schema:
          type: integer
    get:
      summary: Show Post Statistics
      operationId: showPostStatistics
      description: Show the statistics of a post like purchases, views, likes, tips
        and more.
      parameters:
        - in: query
          name: with_historical_data
          description: Set to `true` to include historical data for a post.
          example: true
          required: false
          schema:
            type: boolean
            description: Set to `true` to include historical data for a post.
            example: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    isAvailable: true
                    hasStats: false
                    hasVideo: false
                    lookCount: 0
                    uniqueLookCount: 0
                    uniqueLookChart:
                      - date: 2025-06-20T19:00:00+00:00
                        count: 0
                      - date: 2025-06-20T20:00:00+00:00
                        count: 0
                      - date: 2025-06-20T21:00:00+00:00
                        count: 0
                      - date: 2025-06-20T22:00:00+00:00
                        count: 0
                      - date: 2025-06-20T23:00:00+00:00
                        count: 0
                      - date: 2025-06-21T00:00:00+00:00
                        count: 0
                    lookChart:
                      - date: 2025-06-20T19:00:00+00:00
                        count: 0
                      - date: 2025-06-20T20:00:00+00:00
                        count: 0
                      - date: 2025-06-20T21:00:00+00:00
                        count: 0
                      - date: 2025-06-20T22:00:00+00:00
                        count: 0
                      - date: 2025-06-20T23:00:00+00:00
                        count: 0
                      - date: 2025-06-21T00:00:00+00:00
                        count: 0
                    lookDuration: 0
                    lookDurationAverage: 0
                    likeCount: 0
                    likeChart:
                      - date: 2025-06-20T19:00:00+00:00
                        count: 0
                      - date: 2025-06-20T20:00:00+00:00
                        count: 0
                      - date: 2025-06-20T21:00:00+00:00
                        count: 0
                      - date: 2025-06-20T22:00:00+00:00
                        count: 0
                      - date: 2025-06-20T23:00:00+00:00
                        count: 0
                      - date: 2025-06-21T00:00:00+00:00
                        count: 0
                    commentCount: 0
                    commentChart:
                      - date: 2025-06-20T19:00:00+00:00
                        count: 0
                      - date: 2025-06-20T20:00:00+00:00
                        count: 0
                      - date: 2025-06-20T21:00:00+00:00
                        count: 0
                      - date: 2025-06-20T22:00:00+00:00
                        count: 0
                      - date: 2025-06-20T23:00:00+00:00
                        count: 0
                      - date: 2025-06-21T00:00:00+00:00
                        count: 0
                    tipCount: 0
                    tipChart:
                      - date: 2025-06-20T19:00:00+00:00
                        count: 0
                      - date: 2025-06-20T20:00:00+00:00
                        count: 0
                      - date: 2025-06-20T21:00:00+00:00
                        count: 0
                      - date: 2025-06-20T22:00:00+00:00
                        count: 0
                      - date: 2025-06-20T23:00:00+00:00
                        count: 0
                      - date: 2025-06-21T00:00:00+00:00
                        count: 0
                    tipSum: 0
                    purchasedCount: 0
                    purchasedSumm: 0
                    tipSumChart:
                      - date: 2025-06-20T19:00:00+00:00
                        count: 0
                      - date: 2025-06-20T20:00:00+00:00
                        count: 0
                      - date: 2025-06-20T21:00:00+00:00
                        count: 0
                      - date: 2025-06-20T22:00:00+00:00
                        count: 0
                      - date: 2025-06-20T23:00:00+00:00
                        count: 0
                      - date: 2025-06-21T00:00:00+00:00
                        count: 0
                    purchasesChart:
                      - date: 2025-06-20T19:00:00+00:00
                        count: 0
                      - date: 2025-06-20T20:00:00+00:00
                        count: 0
                      - date: 2025-06-20T21:00:00+00:00
                        count: 0
                      - date: 2025-06-20T22:00:00+00:00
                        count: 0
                      - date: 2025-06-20T23:00:00+00:00
                        count: 0
                      - date: 2025-06-21T00:00:00+00:00
                        count: 0
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999878
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 996
                      remaining_day: 49885
                properties:
                  data:
                    type: object
                    properties:
                      isAvailable:
                        type: boolean
                        example: true
                      hasStats:
                        type: boolean
                        example: false
                      hasVideo:
                        type: boolean
                        example: false
                      lookCount:
                        type: integer
                        example: 0
                      uniqueLookCount:
                        type: integer
                        example: 0
                      uniqueLookChart:
                        type: array
                        example:
                          - date: 2025-06-20T19:00:00+00:00
                            count: 0
                          - date: 2025-06-20T20:00:00+00:00
                            count: 0
                          - date: 2025-06-20T21:00:00+00:00
                            count: 0
                          - date: 2025-06-20T22:00:00+00:00
                            count: 0
                          - date: 2025-06-20T23:00:00+00:00
                            count: 0
                          - date: 2025-06-21T00:00:00+00:00
                            count: 0
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: 2025-06-20T19:00:00+00:00
                            count:
                              type: integer
                              example: 0
                      lookChart:
                        type: array
                        example:
                          - date: 2025-06-20T19:00:00+00:00
                            count: 0
                          - date: 2025-06-20T20:00:00+00:00
                            count: 0
                          - date: 2025-06-20T21:00:00+00:00
                            count: 0
                          - date: 2025-06-20T22:00:00+00:00
                            count: 0
                          - date: 2025-06-20T23:00:00+00:00
                            count: 0
                          - date: 2025-06-21T00:00:00+00:00
                            count: 0
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: 2025-06-20T19:00:00+00:00
                            count:
                              type: integer
                              example: 0
                      lookDuration:
                        type: integer
                        example: 0
                      lookDurationAverage:
                        type: integer
                        example: 0
                      likeCount:
                        type: integer
                        example: 0
                      likeChart:
                        type: array
                        example:
                          - date: 2025-06-20T19:00:00+00:00
                            count: 0
                          - date: 2025-06-20T20:00:00+00:00
                            count: 0
                          - date: 2025-06-20T21:00:00+00:00
                            count: 0
                          - date: 2025-06-20T22:00:00+00:00
                            count: 0
                          - date: 2025-06-20T23:00:00+00:00
                            count: 0
                          - date: 2025-06-21T00:00:00+00:00
                            count: 0
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: 2025-06-20T19:00:00+00:00
                            count:
                              type: integer
                              example: 0
                      commentCount:
                        type: integer
                        example: 0
                      commentChart:
                        type: array
                        example:
                          - date: 2025-06-20T19:00:00+00:00
                            count: 0
                          - date: 2025-06-20T20:00:00+00:00
                            count: 0
                          - date: 2025-06-20T21:00:00+00:00
                            count: 0
                          - date: 2025-06-20T22:00:00+00:00
                            count: 0
                          - date: 2025-06-20T23:00:00+00:00
                            count: 0
                          - date: 2025-06-21T00:00:00+00:00
                            count: 0
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: 2025-06-20T19:00:00+00:00
                            count:
                              type: integer
                              example: 0
                      tipCount:
                        type: integer
                        example: 0
                      tipChart:
                        type: array
                        example:
                          - date: 2025-06-20T19:00:00+00:00
                            count: 0
                          - date: 2025-06-20T20:00:00+00:00
                            count: 0
                          - date: 2025-06-20T21:00:00+00:00
                            count: 0
                          - date: 2025-06-20T22:00:00+00:00
                            count: 0
                          - date: 2025-06-20T23:00:00+00:00
                            count: 0
                          - date: 2025-06-21T00:00:00+00:00
                            count: 0
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: 2025-06-20T19:00:00+00:00
                            count:
                              type: integer
                              example: 0
                      tipSum:
                        type: integer
                        example: 0
                      purchasedCount:
                        type: integer
                        example: 0
                      purchasedSumm:
                        type: integer
                        example: 0
                      tipSumChart:
                        type: array
                        example:
                          - date: 2025-06-20T19:00:00+00:00
                            count: 0
                          - date: 2025-06-20T20:00:00+00:00
                            count: 0
                          - date: 2025-06-20T21:00:00+00:00
                            count: 0
                          - date: 2025-06-20T22:00:00+00:00
                            count: 0
                          - date: 2025-06-20T23:00:00+00:00
                            count: 0
                          - date: 2025-06-21T00:00:00+00:00
                            count: 0
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: 2025-06-20T19:00:00+00:00
                            count:
                              type: integer
                              example: 0
                      purchasesChart:
                        type: array
                        example:
                          - date: 2025-06-20T19:00:00+00:00
                            count: 0
                          - date: 2025-06-20T20:00:00+00:00
                            count: 0
                          - date: 2025-06-20T21:00:00+00:00
                            count: 0
                          - date: 2025-06-20T22:00:00+00:00
                            count: 0
                          - date: 2025-06-20T23:00:00+00:00
                            count: 0
                          - date: 2025-06-21T00:00:00+00:00
                            count: 0
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: 2025-06-20T19:00:00+00:00
                            count:
                              type: integer
                              example: 0
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999878
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 996
                          remaining_day:
                            type: integer
                            example: 49885
      tags:
        - Posts
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Unarchive Post (/api-reference/posts/unarchive-post)

Unarchive a post from your account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/posts/{post_id}/unarchive
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/posts/{post_id}/unarchive:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: post_id
        description: The ID of the post
        example: 1234567890
        required: true
        schema:
          type: integer
    post:
      summary: Unarchive Post
      operationId: unarchivePost
      description: Unarchive a post from your account.
      parameters:
        - in: query
          name: private_archive
          description: Set to `true` if this post is currently in the Private Archive.
          example: true
          required: false
          schema:
            type: boolean
            description: Set to `true` if this post is currently in the Private Archive.
            example: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    labelStates:
                      - id: archived
                        name: Archive
                        type: archived
                        isClearInProgress: false
                        postsCount: 0
                        posts: []
                    counters:
                      audiosCount: 0
                      photosCount: 0
                      videosCount: 0
                      mediasCount: 0
                      postsCount: 2
                      streamsCount: 0
                      archivedPostsCount: 0
                      privateArchivedPostsCount: 0
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999903
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49919
                properties:
                  data:
                    type: object
                    properties:
                      labelStates:
                        type: array
                        example:
                          - id: archived
                            name: Archive
                            type: archived
                            isClearInProgress: false
                            postsCount: 0
                            posts: []
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: archived
                            name:
                              type: string
                              example: Archive
                            type:
                              type: string
                              example: archived
                            isClearInProgress:
                              type: boolean
                              example: false
                            postsCount:
                              type: integer
                              example: 0
                            posts:
                              type: array
                              example: []
                      counters:
                        type: object
                        properties:
                          audiosCount:
                            type: integer
                            example: 0
                          photosCount:
                            type: integer
                            example: 0
                          videosCount:
                            type: integer
                            example: 0
                          mediasCount:
                            type: integer
                            example: 0
                          postsCount:
                            type: integer
                            example: 2
                          streamsCount:
                            type: integer
                            example: 0
                          archivedPostsCount:
                            type: integer
                            example: 0
                          privateArchivedPostsCount:
                            type: integer
                            example: 0
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999903
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49919
      tags:
        - Posts
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Update Post (/api-reference/posts/update-post)

Update a posted, queued, or "saved for later" post.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml put /api/{account}/posts/{post_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/posts/{post_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: post_id
        description: The ID of the post
        example: 1234567890
        required: true
        schema:
          type: integer
    put:
      summary: Update Post
      operationId: updatePost
      description: Update a posted, queued, or "saved for later" post.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            text/plain:
              schema:
                type: string
                example: ""
      tags:
        - Posts
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: The post text content
                  example: Hello!
                labelIds:
                  type: string
                  description: Array of OF label IDs. Refer to our `/posts/labels` endpoint.
                  example:
                    - 123
                price:
                  type: integer
                  description: Price for paid content (0 or between 3-100). In case this is not
                    zero, **mediaFiles** is required
                  example: 10
                mediaFiles:
                  type: string
                  description: Array of OFAPI `ofapi_media_` IDs, or OF media IDs
                  example:
                    - ofapi_media_abc123
                    - "1234567890"
                rfTag:
                  type: string
                  description: Array OnlyFans creator user IDs to tag in your post
                  example:
                    - 123
                expireDays:
                  type: integer
                  description: Number of days after which the post will expire. Between 1 and 30
                    days. Keep empty for no expiration.
                  example: 3
                scheduledDate:
                  type: string
                  description: Schedule your post in the future (UTC timezone).
                  example: 2025-01-01T00:00:00.000Z
                saveForLater:
                  type: boolean
                  description: Add your post to the "Saved for later" queue.
                  example: true
                fundRaisingTargetAmount:
                  type: integer
                  description: Add a fundraising target to your post. If present, value must be at
                    least 10.
                  example: 30
                fundRaisingTipsPresets:
                  type: array
                  description: Specify which tip amounts will be listed under the fundraising
                    card. Required with `fundRaisingTargetAmount`, and you must
                    provide at least 1 option. Array items cannot be higher than
                    the `fundRaisingTargetAmount`.
                  example:
                    - 5
                    - 10
                    - 15
                  items:
                    type: string
                votingType:
                  type: string
                  description: Include a poll or quiz within your post.
                  example: poll
                  enum:
                    - poll
                    - quiz
                votingDue:
                  type: integer
                  description: The due date (in days) of your poll/quiz. Can be 1, 3, 7 or 30
                    days. Can only be filled with `votingType`.
                  example: 3
                votingOptions:
                  type: array
                  description: The options of your poll/quiz. Required with `votingType`.
                  example:
                    - First option
                    - Second option
                  items:
                    type: string
                votingCorrectIndex:
                  type: integer
                  description: The array key of your quiz' correct answer. Required when
                    `votingType` is "quiz". Keep in mind that arrays start at
                    `0`
                  example: 0
                blockBannedWords:
                  type: string
                  description: Screen `text` for OnlyFans banned words and block the update if any
                    are found (returns a 422 listing the offending words).
                    `strict_ban` blocks all tiers, `risky` blocks Risky +
                    Replace/soften, `replace_soften` blocks Replace/soften only.
                    Omit to disable screening.
                  example: strict_ban
                  enum:
                    - strict_ban
                    - risky
                    - replace_soften
              required:
                - text
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Create Promotion (/api-reference/promotions/create-promotion)

Create a new promotion for the account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/promotions
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/promotions:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Create Promotion
      operationId: createPromotion
      description: Create a new promotion for the account.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - id: 123
                      message: Example promotion message
                      rawMessage: Example promotion message
                      hasRelatedPromo: false
                      price: 0
                      type: all
                      canClaim: true
                      claimsCount: 0
                      subscribeCounts: 10
                      subscribeDays: 7
                      createdAt: 2025-01-01T00:00:00+00:00
                      finishedAt: 2025-01-02T00:00:00+00:00
                      isFinished: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999816
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: null
                      remaining_minute: 998
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: array
                    example:
                      - id: 123
                        message: Example promotion message
                        rawMessage: Example promotion message
                        hasRelatedPromo: false
                        price: 0
                        type: all
                        canClaim: true
                        claimsCount: 0
                        subscribeCounts: 10
                        subscribeDays: 7
                        createdAt: 2025-01-01T00:00:00+00:00
                        finishedAt: 2025-01-02T00:00:00+00:00
                        isFinished: false
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 123
                        message:
                          type: string
                          example: Example promotion message
                        rawMessage:
                          type: string
                          example: Example promotion message
                        hasRelatedPromo:
                          type: boolean
                          example: false
                        price:
                          type: integer
                          example: 0
                        type:
                          type: string
                          example: all
                        canClaim:
                          type: boolean
                          example: true
                        claimsCount:
                          type: integer
                          example: 0
                        subscribeCounts:
                          type: integer
                          example: 10
                        subscribeDays:
                          type: integer
                          example: 7
                        createdAt:
                          type: string
                          example: 2025-01-01T00:00:00+00:00
                        finishedAt:
                          type: string
                          example: 2025-01-02T00:00:00+00:00
                        isFinished:
                          type: boolean
                          example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999816
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Promotions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  description: "Whether this promotion should apply to new subscribers, expired
                    subscribers, or both. **IMPORTANT: when set to
                    new_and_expired, the OF will create two separate
                    promotions.**"
                  example: new
                  enum:
                    - new
                    - expired
                    - new_and_expired
                discount:
                  type: integer
                  description: The discount percentage for the promotion's first month. Set to 100
                    to make this promotion a Free Trial.
                  example: 10
                offerLimit:
                  type: integer
                  description: Limit how many people can claim this offer. Set to 0 for no limits.
                  example: 10
                expirationDays:
                  type: integer
                  description: In how many days this offer will expire. Set to 0 to make this
                    promotion infinite.
                  example: 7
                freeTrialDays:
                  type: integer
                  description: Required only when discount is 100. Sets the duration (in days) of
                    the free trial. Accepted 1-30
                  example: 10
                message:
                  type: string
                  description: Optionally, provide a message for this promotion.
                  example: Enjoy this special offer!
              required:
                - type
                - discount
                - offerLimit
                - expirationDays
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Delete Promotion (/api-reference/promotions/delete-promotion)

Delete a promotion for the account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/promotions/{promotion_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/promotions/{promotion_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: promotion_id
        description: The ID of the promotion to delete.
        example: 123
        required: true
        schema:
          type: string
    delete:
      summary: Delete Promotion
      operationId: deletePromotion
      description: Delete a promotion for the account.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999818
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: null
                      remaining_minute: 999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999818
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Promotions
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Promotions (/api-reference/promotions/list-promotions)

List all promotions for the account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/promotions
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/promotions:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Promotions
      operationId: listPromotions
      description: List all promotions for the account.
      parameters:
        - in: query
          name: limit
          description: The number of promotions to return. Default `10`
          example: 10
          required: false
          schema:
            type: integer
            description: The number of promotions to return. Default `10`
            example: 10
        - in: query
          name: offset
          description: The offset used for pagination. Default `0`
          example: 0
          required: false
          schema:
            type: integer
            description: The offset used for pagination. Default `0`
            example: 0
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    hasMore: false
                    items:
                      - id: 123
                        message: Example promotion message
                        rawMessage: Example promotion message
                        hasRelatedPromo: false
                        price: 0
                        type: all
                        canClaim: true
                        claimsCount: 0
                        subscribeCounts: 10
                        subscribeDays: 7
                        createdAt: 2025-01-01T00:00:00+00:00
                        finishedAt: 2025-01-02T00:00:00+00:00
                        isFinished: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999823
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: null
                      remaining_minute: 999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      hasMore:
                        type: boolean
                        example: false
                      items:
                        type: array
                        example:
                          - id: 123
                            message: Example promotion message
                            rawMessage: Example promotion message
                            hasRelatedPromo: false
                            price: 0
                            type: all
                            canClaim: true
                            claimsCount: 0
                            subscribeCounts: 10
                            subscribeDays: 7
                            createdAt: 2025-01-01T00:00:00+00:00
                            finishedAt: 2025-01-02T00:00:00+00:00
                            isFinished: false
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            message:
                              type: string
                              example: Example promotion message
                            rawMessage:
                              type: string
                              example: Example promotion message
                            hasRelatedPromo:
                              type: boolean
                              example: false
                            price:
                              type: integer
                              example: 0
                            type:
                              type: string
                              example: all
                            canClaim:
                              type: boolean
                              example: true
                            claimsCount:
                              type: integer
                              example: 0
                            subscribeCounts:
                              type: integer
                              example: 10
                            subscribeDays:
                              type: integer
                              example: 7
                            createdAt:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            finishedAt:
                              type: string
                              example: 2025-01-02T00:00:00+00:00
                            isFinished:
                              type: boolean
                              example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999823
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Promotions
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Stop Promotion (/api-reference/promotions/stop-promotion)

Stop an active promotion for the account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/promotions/{promotion_id}/stop
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/promotions/{promotion_id}/stop:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: promotion_id
        description: The ID of the promotion to stop.
        example: 123
        required: true
        schema:
          type: string
    post:
      summary: Stop Promotion
      operationId: stopPromotion
      description: Stop an active promotion for the account.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999819
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: null
                      remaining_minute: 999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999819
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Promotions
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Create Label (/api-reference/post-labels/create-label)

Create a new post label.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/posts/labels
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/posts/labels:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Create Label
      operationId: createLabel
      description: Create a new post label.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    name: My new label
                    type: custom
                    isClearInProgress: false
                    postsCount: 0
                    posts: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999941
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49988
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      name:
                        type: string
                        example: My new label
                      type:
                        type: string
                        example: custom
                      isClearInProgress:
                        type: boolean
                        example: false
                      postsCount:
                        type: integer
                        example: 0
                      posts:
                        type: array
                        example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999941
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49988
      tags:
        - Post Labels
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The name of your new label
                  example: My new label
              required:
                - name
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Labels (/api-reference/post-labels/list-labels)

List the labels that you can use to organize your posts.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/posts/labels
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/posts/labels:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Labels
      operationId: listLabels
      description: List the labels that you can use to organize your posts.
      parameters:
        - in: query
          name: limit
          description: Number of labels to return (default = 10)
          example: 10
          required: false
          schema:
            type: string
            description: Number of labels to return (default = 10)
            example: 10
        - in: query
          name: offset
          description: Number of labels to skip for pagination
          example: 0
          required: false
          schema:
            type: string
            description: Number of labels to skip for pagination
            example: 0
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - id: archived
                        name: Archive
                        type: archived
                        isClearInProgress: false
                        postsCount: 0
                        posts: []
                      - id: private_archived
                        name: Private Archive
                        type: private_archived
                        isClearInProgress: false
                        postsCount: 0
                        posts: []
                      - id: 123
                        name: My new label
                        type: custom
                        isClearInProgress: false
                        postsCount: 123
                        posts: []
                    order: asc
                    sort: default
                    hasMore: false
                    nextOffset: 10
                    hashSort: abc123
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999940
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49987
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - id: archived
                            name: Archive
                            type: archived
                            isClearInProgress: false
                            postsCount: 0
                            posts: []
                          - id: private_archived
                            name: Private Archive
                            type: private_archived
                            isClearInProgress: false
                            postsCount: 0
                            posts: []
                          - id: 123
                            name: My new label
                            type: custom
                            isClearInProgress: false
                            postsCount: 123
                            posts: []
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: archived
                            name:
                              type: string
                              example: Archive
                            type:
                              type: string
                              example: archived
                            isClearInProgress:
                              type: boolean
                              example: false
                            postsCount:
                              type: integer
                              example: 0
                            posts:
                              type: array
                              example: []
                      order:
                        type: string
                        example: asc
                      sort:
                        type: string
                        example: default
                      hasMore:
                        type: boolean
                        example: false
                      nextOffset:
                        type: integer
                        example: 10
                      hashSort:
                        type: string
                        example: abc123
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999940
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49987
      tags:
        - Post Labels
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Profile Details (/api-reference/public-profiles/get-profile-details)

Get profile details by username.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/profiles/{username}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/profiles/{username}:
    parameters:
      - in: path
        name: username
        description: The username of the profile to get
        example: madison420ivy
        required: true
        schema:
          type: string
    get:
      summary: Get Profile Details
      operationId: getProfileDetails
      description: Get profile details by username.
      parameters:
        - in: query
          name: fresh
          description: If `true` then OnlyFansAPI will always return the real time
            information about profile (eg. when was the profile last online).
          example: false
          required: false
          schema:
            type: boolean
            description: If `true` then OnlyFansAPI will always return the real time
              information about profile (eg. when was the profile last online).
            example: false
            nullable: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    ofapi_gender: female
                    ofapi_gender_confidence: 0.99
                    view: f
                    avatar: https://public.onlyfans.com/files/w/w6/w6g/.../123/avatar.jpg
                    avatarThumbs:
                      c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/w/w6/w6g/.../123/avatar.jpg
                      c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/w/w6/w6g/.../123/avatar.jpg
                    header: https://public.onlyfans.com/files/k/kk/kk6/.../123/header_image.jpg
                    headerSize:
                      width: 760
                      height: 570
                    headerThumbs:
                      w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/k/kk/kk6/.../123/header_image.jpg
                      w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/k/kk/kk6/.../123/header_image.jpg
                    id: 123
                    name: name
                    username: username
                    canLookStory: false
                    canCommentStory: false
                    hasNotViewedStory: false
                    isVerified: true
                    canPayInternal: false
                    hasScheduledStream: false
                    hasStream: false
                    hasStories: false
                    tipsEnabled: false
                    tipsTextEnabled: true
                    tipsMin: 5
                    tipsMinInternal: 1
                    tipsMax: 200
                    canEarn: true
                    canAddSubscriber: true
                    subscribePrice: 0
                    isRestricted: false
                    canRestrict: true
                    subscribedBy: false
                    subscribedByExpire: null
                    subscribedByExpireDate: null
                    subscribedByAutoprolong: null
                    subscribedIsExpiredNow: null
                    currentSubscribePrice: null
                    subscribedOn: false
                    subscribedOnExpiredNow: null
                    subscribedOnDuration: null
                    joinDate: 2025-01-01T01:01:01+00:00
                    isReferrerAllowed: true
                    about: ""
                    isMarkdownDisabledForAbout: true
                    website: https://onlyfans.com
                    wishlist: null
                    location: null
                    postsCount: 2
                    archivedPostsCount: 0
                    privateArchivedPostsCount: 0
                    photosCount: 0
                    videosCount: 0
                    audiosCount: 0
                    mediasCount: 0
                    lastSeen: 2025-01-01T01:01:01+00:00
                    favoritesCount: 0
                    favoritedCount: 0
                    showPostsInFeed: false
                    canReceiveChatMessage: false
                    isPerformer: true
                    isRealPerformer: false
                    isSpotifyConnected: false
                    subscribersCount: null
                    hasPinnedPosts: true
                    hasLabels: true
                    canChat: true
                    avatarHeaderConverterUpload: true
                    isPrivateRestriction: false
                    showSubscribersCount: false
                    showMediaCount: true
                    subscribedByData: null
                    subscribedOnData: null
                    canCreatePromotion: false
                    canCreateTrial: false
                    isAdultContent: false
                    canTrialSend: false
                    hasLinks: false
                    referalBonusSummForReferer: 0
                    firstPublishedPostDate: 2025-01-01T01:01:01+00:00
                    isSpringConnected: false
                    isFriend: false
                    isBlocked: false
                    canReport: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999835
                      note: Cache MISS. We had to make a new request to OnlyFans.com because the cache
                        expired
                    _cache:
                      is_cached: false
                      note: Cache MISS. We had to make a new request to OnlyFans.com
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49993
                properties:
                  data:
                    type: object
                    properties:
                      ofapi_gender:
                        type: string
                        example: female
                      ofapi_gender_confidence:
                        type: number
                        example: 0.99
                      view:
                        type: string
                        example: f
                      avatar:
                        type: string
                        example: https://public.onlyfans.com/files/w/w6/w6g/.../123/avatar.jpg
                      avatarThumbs:
                        type: object
                        properties:
                          c50:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/c50/w/w6/w6g/.../123/avatar.jpg
                          c144:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/c144/w/w6/w6g/.../123/avatar.jpg
                      header:
                        type: string
                        example: https://public.onlyfans.com/files/k/kk/kk6/.../123/header_image.jpg
                      headerSize:
                        type: object
                        properties:
                          width:
                            type: integer
                            example: 760
                          height:
                            type: integer
                            example: 570
                      headerThumbs:
                        type: object
                        properties:
                          w480:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/w480/k/kk/kk6/.../123/header_image.jpg
                          w760:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/w760/k/kk/kk6/.../123/header_image.jpg
                      id:
                        type: integer
                        example: 123
                      name:
                        type: string
                        example: name
                      username:
                        type: string
                        example: username
                      canLookStory:
                        type: boolean
                        example: false
                      canCommentStory:
                        type: boolean
                        example: false
                      hasNotViewedStory:
                        type: boolean
                        example: false
                      isVerified:
                        type: boolean
                        example: true
                      canPayInternal:
                        type: boolean
                        example: false
                      hasScheduledStream:
                        type: boolean
                        example: false
                      hasStream:
                        type: boolean
                        example: false
                      hasStories:
                        type: boolean
                        example: false
                      tipsEnabled:
                        type: boolean
                        example: false
                      tipsTextEnabled:
                        type: boolean
                        example: true
                      tipsMin:
                        type: integer
                        example: 5
                      tipsMinInternal:
                        type: integer
                        example: 1
                      tipsMax:
                        type: integer
                        example: 200
                      canEarn:
                        type: boolean
                        example: true
                      canAddSubscriber:
                        type: boolean
                        example: true
                      subscribePrice:
                        type: integer
                        example: 0
                      isRestricted:
                        type: boolean
                        example: false
                      canRestrict:
                        type: boolean
                        example: true
                      subscribedBy:
                        type: boolean
                        example: false
                      subscribedByExpire:
                        type: string
                        example: null
                        nullable: true
                      subscribedByExpireDate:
                        type: string
                        example: null
                        nullable: true
                      subscribedByAutoprolong:
                        type: string
                        example: null
                        nullable: true
                      subscribedIsExpiredNow:
                        type: string
                        example: null
                        nullable: true
                      currentSubscribePrice:
                        type: string
                        example: null
                        nullable: true
                      subscribedOn:
                        type: boolean
                        example: false
                      subscribedOnExpiredNow:
                        type: string
                        example: null
                        nullable: true
                      subscribedOnDuration:
                        type: string
                        example: null
                        nullable: true
                      joinDate:
                        type: string
                        example: 2025-01-01T01:01:01+00:00
                      isReferrerAllowed:
                        type: boolean
                        example: true
                      about:
                        type: string
                        example: ""
                      isMarkdownDisabledForAbout:
                        type: boolean
                        example: true
                      website:
                        type: string
                        example: https://onlyfans.com
                      wishlist:
                        type: string
                        example: null
                        nullable: true
                      location:
                        type: string
                        example: null
                        nullable: true
                      postsCount:
                        type: integer
                        example: 2
                      archivedPostsCount:
                        type: integer
                        example: 0
                      privateArchivedPostsCount:
                        type: integer
                        example: 0
                      photosCount:
                        type: integer
                        example: 0
                      videosCount:
                        type: integer
                        example: 0
                      audiosCount:
                        type: integer
                        example: 0
                      mediasCount:
                        type: integer
                        example: 0
                      lastSeen:
                        type: string
                        example: 2025-01-01T01:01:01+00:00
                      favoritesCount:
                        type: integer
                        example: 0
                      favoritedCount:
                        type: integer
                        example: 0
                      showPostsInFeed:
                        type: boolean
                        example: false
                      canReceiveChatMessage:
                        type: boolean
                        example: false
                      isPerformer:
                        type: boolean
                        example: true
                      isRealPerformer:
                        type: boolean
                        example: false
                      isSpotifyConnected:
                        type: boolean
                        example: false
                      subscribersCount:
                        type: string
                        example: null
                        nullable: true
                      hasPinnedPosts:
                        type: boolean
                        example: true
                      hasLabels:
                        type: boolean
                        example: true
                      canChat:
                        type: boolean
                        example: true
                      avatarHeaderConverterUpload:
                        type: boolean
                        example: true
                      isPrivateRestriction:
                        type: boolean
                        example: false
                      showSubscribersCount:
                        type: boolean
                        example: false
                      showMediaCount:
                        type: boolean
                        example: true
                      subscribedByData:
                        type: string
                        example: null
                        nullable: true
                      subscribedOnData:
                        type: string
                        example: null
                        nullable: true
                      canCreatePromotion:
                        type: boolean
                        example: false
                      canCreateTrial:
                        type: boolean
                        example: false
                      isAdultContent:
                        type: boolean
                        example: false
                      canTrialSend:
                        type: boolean
                        example: false
                      hasLinks:
                        type: boolean
                        example: false
                      referalBonusSummForReferer:
                        type: integer
                        example: 0
                      firstPublishedPostDate:
                        type: string
                        example: 2025-01-01T01:01:01+00:00
                      isSpringConnected:
                        type: boolean
                        example: false
                      isFriend:
                        type: boolean
                        example: false
                      isBlocked:
                        type: boolean
                        example: false
                      canReport:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999835
                          note:
                            type: string
                            example: Cache MISS. We had to make a new request to OnlyFans.com because the
                              cache expired
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache MISS. We had to make a new request to OnlyFans.com
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49993
      tags:
        - Public Profiles
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Search Profiles (/api-reference/public-profiles/search-profiles)

Full-text search for profiles with filters for pricing, free trials, location, media count and more.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/search
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/search:
    get:
      summary: Search Profiles
      operationId: searchProfiles
      description: Full-text search for profiles with filters for pricing, free
        trials, location, media count and more.
      parameters:
        - in: query
          name: query
          description: Query for full text search in username, display name, bio. Must be
            at least 3 characters.
          example: null
          required: false
          schema:
            type: string
            description: Query for full text search in username, display name, bio. Must be
              at least 3 characters.
            example: null
        - in: query
          name: min_subscribe_price
          description: Filter by minimum subscribe price. Must be at least 0.00.
          example: 0
          required: false
          schema:
            type: number
            description: Filter by minimum subscribe price. Must be at least 0.00.
            example: 0
        - in: query
          name: max_subscribe_price
          description: Filter by maximum subscribe price. Must be at least 0.00.
          example: 200
          required: false
          schema:
            type: number
            description: Filter by maximum subscribe price. Must be at least 0.00.
            example: 200
        - in: query
          name: location
          description: Filter by location.
          example: null
          required: false
          schema:
            type: string
            description: Filter by location.
            example: null
        - in: query
          name: website
          description: Filter by website.
          example: null
          required: false
          schema:
            type: string
            description: Filter by website.
            example: null
        - in: query
          name: instagram
          description: Filter by Instagram username.
          example: null
          required: false
          schema:
            type: string
            description: Filter by Instagram username.
            example: null
        - in: query
          name: tiktok
          description: Filter by TikTok username.
          example: null
          required: false
          schema:
            type: string
            description: Filter by TikTok username.
            example: null
        - in: query
          name: limit
          description: "The number of profiles to return. For each returned profile we
            charge your account 1 credit. Default: `10`. Must be at least 1.
            Must not be greater than 100."
          example: 10
          required: false
          schema:
            type: integer
            description: "The number of profiles to return. For each returned profile we
              charge your account 1 credit. Default: `10`. Must be at least 1.
              Must not be greater than 100."
            example: 10
        - in: query
          name: cursor
          description: Cursor for pagination. Use the `next_cursor` from the previous
            response to get the next page of results.
          example: null
          required: false
          schema:
            type: string
            description: Cursor for pagination. Use the `next_cursor` from the previous
              response to get the next page of results.
            example: null
            nullable: true
        - in: query
          name: sort
          description: Field to sort by. ⭐️ Only available on the Pro and Enterprise plan.
          example: null
          required: false
          schema:
            type: string
            description: Field to sort by. ⭐️ Only available on the Pro and Enterprise plan.
            example: null
            enum:
              - likes
              - photos
              - videos
              - subscribers
              - subscribe_price
              - min_subscribe_price
              - join_date
              - last_seen
        - in: query
          name: sortDirection
          description: Direction for sorting. `desc` - highest value first. `asc` - lowest
            value first.
          example: null
          required: false
          schema:
            type: string
            description: Direction for sorting. `desc` - highest value first. `asc` - lowest
              value first.
            example: null
            enum:
              - desc
              - asc
        - in: query
          name: filter
          description: ""
          example: []
          required: false
          schema:
            type: object
            description: ""
            example: []
            properties: {}
        - in: query
          name: filter.gender
          description: "Filter by gender (available: `female`, `male`, `trans`,
            `trans_ftm` (Female-to-Male), `trans_mft` (Male-to-Female),
            `couple`). ⭐️ Only available on the Pro and Enterprise plan."
          example: null
          required: false
          schema:
            type: string
            description: "Filter by gender (available: `female`, `male`, `trans`,
              `trans_ftm` (Female-to-Male), `trans_mft` (Male-to-Female),
              `couple`). ⭐️ Only available on the Pro and Enterprise plan."
            example: null
            enum:
              - female
              - male
              - trans
              - trans_ftm
              - trans_mtf
              - couple
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - ofapi_gender: female
                      ofapi_gender_confidence: 0.98
                      onlyfans_id: 5140520
                      stats_updated_at: 2025-12-15T21:00:42.000000Z
                      username: madison420ivy
                      name: Madison Ivy
                      avatar_url: https://public.onlyfans.com/files/v/v3/v30/v302xscgzgb1qijezrvsotwo4dxn00pe1760573833/5140520/avatar.jpg
                      header_url: https://public.onlyfans.com/files/i/iz/izt/iztyiyvqu9mg54vccnxjjivnkz2cyivm1617484103/header.jpg
                      subscribe_price: 0
                      min_subscribe_price: 0
                      posts_count: 157
                      photos_count: 530
                      videos_count: 207
                      audios_count: 0
                      favorites_count: 16
                      favorited_count: 570621
                      subscribers_count: null
                      is_verified: true
                      website: Www.fleshlight.com/Madisonivy
                      location: CannaBliss
                      wishlist: null
                      about: <p>My wish in life is to be your personal lil fuck toy. WELCOME to my
                        naughty corner of the world. <br /> I hope you’ll love
                        my extremely up-close and personal POVs. I want to give
                        you a true feeling of being with me. <br /> Let me tease
                        you and please you.<br /> Command me, Master. For I am
                        your little pet. <br /> And I am waiting… 😈💦<br /><br
                        /> I absolutely love suggestions, so please feel free to
                        send me a DM with ideas! I always try to include as much
                        as possibles 💋<br /> 🚨Also about my page
                        👇👇👇👇👇👇👇👇<br /><br />
                        ...............................................................................................<br
                        /> 💖 Custom Video Contest is returning soon!!!<br />
                        (Watch page for details)<br /> 💙Tipping is NEVER
                        required. <br /> (But because my page is free, I’m
                        starting to only respond to messages with tips. I’m very
                        sorry about this, but for the past 5 years I’ve answered
                        every single message. And they’re just isn’t enough time
                        in the day.)  <br /> Xoxo<br />     Ur little fuck
                        toy,<br />           </p>
                      last_seen_at: null
                      is_performer: true
                      is_real_performer: true
                      is_adult_content: false
                      bundles: null
                      instagram: null
                      twitter: null
                      tiktok: null
                      facebook: null
                      promotions: null
                      join_date: 2018-11-11T00:00:00.000000Z
                      fansly: null
                      pornhub: null
                      manyvids: null
                    - ofapi_gender: male
                      ofapi_gender_confidence: 0.95
                      onlyfans_id: 117183
                      stats_updated_at: 2025-12-15T21:59:51.000000Z
                      username: johnnysins
                      name: Johnny Sins
                      avatar_url: https://public.onlyfans.com/files/e/ex/exf/exflcllrevoeqnhfeccma55z5desn4ct1686490893/117183/avatar.jpg
                      header_url: null
                      subscribe_price: 0
                      min_subscribe_price: 0
                      posts_count: 9431
                      photos_count: 57499
                      videos_count: 14116
                      audios_count: 1
                      favorites_count: 72
                      favorited_count: 250727
                      subscribers_count: 202344
                      is_verified: true
                      website: https://Onlyfans.com/solojohnny
                      location: null
                      wishlist: null
                      about: <p>THE ONLY OFFICIAL JOHNNY SINS ONLYFANS<br /><br /> 🔥 NEW SUBSCRIBERS
                        GET A FREE VIDEO FOR JOINING!!!<br /> 🔥 NEW scenes 2x
                        per week!! </p>
                      last_seen_at: 2025-12-15T21:01:35.000000Z
                      is_performer: true
                      is_real_performer: true
                      is_adult_content: true
                      bundles: null
                      instagram: Mosttalentedbaldman
                      twitter: johnnysins
                      tiktok: Johnnysins
                      facebook: null
                      promotions: null
                      join_date: 2017-01-25T00:00:00.000000Z
                      fansly: null
                      pornhub: null
                      manyvids: null
                  _pagination:
                    total_results: 10000
                    next_cursor: WzEsIjEwIl0=
                    next_page_url: https://app.onlyfansapi.com/api/search?limit=50&cursor=WzEsIjEwIl0%3D
                  _meta:
                    _credits:
                      used: 1
                      balance: 115530
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49998
                properties:
                  data:
                    type: array
                    example:
                      - ofapi_gender: female
                        ofapi_gender_confidence: 0.98
                        onlyfans_id: 5140520
                        stats_updated_at: 2025-12-15T21:00:42.000000Z
                        username: madison420ivy
                        name: Madison Ivy
                        avatar_url: https://public.onlyfans.com/files/v/v3/v30/v302xscgzgb1qijezrvsotwo4dxn00pe1760573833/5140520/avatar.jpg
                        header_url: https://public.onlyfans.com/files/i/iz/izt/iztyiyvqu9mg54vccnxjjivnkz2cyivm1617484103/header.jpg
                        subscribe_price: 0
                        min_subscribe_price: 0
                        posts_count: 157
                        photos_count: 530
                        videos_count: 207
                        audios_count: 0
                        favorites_count: 16
                        favorited_count: 570621
                        subscribers_count: null
                        is_verified: true
                        website: Www.fleshlight.com/Madisonivy
                        location: CannaBliss
                        wishlist: null
                        about: <p>My wish in life is to be your personal lil fuck toy. WELCOME to my
                          naughty corner of the world. <br /> I hope you’ll love
                          my extremely up-close and personal POVs. I want to
                          give you a true feeling of being with me. <br /> Let
                          me tease you and please you.<br /> Command me, Master.
                          For I am your little pet. <br /> And I am waiting…
                          😈💦<br /><br /> I absolutely love suggestions, so
                          please feel free to send me a DM with ideas! I always
                          try to include as much as possibles 💋<br /> 🚨Also
                          about my page 👇👇👇👇👇👇👇👇<br /><br />
                          ...............................................................................................<br
                          /> 💖 Custom Video Contest is returning soon!!!<br />
                          (Watch page for details)<br /> 💙Tipping is NEVER
                          required. <br /> (But because my page is free, I’m
                          starting to only respond to messages with tips. I’m
                          very sorry about this, but for the past 5 years I’ve
                          answered every single message. And they’re just isn’t
                          enough time in the day.)  <br /> Xoxo<br />     Ur
                          little fuck toy,<br />           </p>
                        last_seen_at: null
                        is_performer: true
                        is_real_performer: true
                        is_adult_content: false
                        bundles: null
                        instagram: null
                        twitter: null
                        tiktok: null
                        facebook: null
                        promotions: null
                        join_date: 2018-11-11T00:00:00.000000Z
                        fansly: null
                        pornhub: null
                        manyvids: null
                      - ofapi_gender: male
                        ofapi_gender_confidence: 0.95
                        onlyfans_id: 117183
                        stats_updated_at: 2025-12-15T21:59:51.000000Z
                        username: johnnysins
                        name: Johnny Sins
                        avatar_url: https://public.onlyfans.com/files/e/ex/exf/exflcllrevoeqnhfeccma55z5desn4ct1686490893/117183/avatar.jpg
                        header_url: null
                        subscribe_price: 0
                        min_subscribe_price: 0
                        posts_count: 9431
                        photos_count: 57499
                        videos_count: 14116
                        audios_count: 1
                        favorites_count: 72
                        favorited_count: 250727
                        subscribers_count: 202344
                        is_verified: true
                        website: https://Onlyfans.com/solojohnny
                        location: null
                        wishlist: null
                        about: <p>THE ONLY OFFICIAL JOHNNY SINS ONLYFANS<br /><br /> 🔥 NEW SUBSCRIBERS
                          GET A FREE VIDEO FOR JOINING!!!<br /> 🔥 NEW scenes 2x
                          per week!! </p>
                        last_seen_at: 2025-12-15T21:01:35.000000Z
                        is_performer: true
                        is_real_performer: true
                        is_adult_content: true
                        bundles: null
                        instagram: Mosttalentedbaldman
                        twitter: johnnysins
                        tiktok: Johnnysins
                        facebook: null
                        promotions: null
                        join_date: 2017-01-25T00:00:00.000000Z
                        fansly: null
                        pornhub: null
                        manyvids: null
                    items:
                      type: object
                      properties:
                        ofapi_gender:
                          type: string
                          example: female
                        ofapi_gender_confidence:
                          type: number
                          example: 0.98
                        onlyfans_id:
                          type: integer
                          example: 5140520
                        stats_updated_at:
                          type: string
                          example: 2025-12-15T21:00:42.000000Z
                        username:
                          type: string
                          example: madison420ivy
                        name:
                          type: string
                          example: Madison Ivy
                        avatar_url:
                          type: string
                          example: https://public.onlyfans.com/files/v/v3/v30/v302xscgzgb1qijezrvsotwo4dxn00pe1760573833/5140520/avatar.jpg
                        header_url:
                          type: string
                          example: https://public.onlyfans.com/files/i/iz/izt/iztyiyvqu9mg54vccnxjjivnkz2cyivm1617484103/header.jpg
                        subscribe_price:
                          type: integer
                          example: 0
                        min_subscribe_price:
                          type: integer
                          example: 0
                        posts_count:
                          type: integer
                          example: 157
                        photos_count:
                          type: integer
                          example: 530
                        videos_count:
                          type: integer
                          example: 207
                        audios_count:
                          type: integer
                          example: 0
                        favorites_count:
                          type: integer
                          example: 16
                        favorited_count:
                          type: integer
                          example: 570621
                        subscribers_count:
                          type: string
                          example: null
                          nullable: true
                        is_verified:
                          type: boolean
                          example: true
                        website:
                          type: string
                          example: Www.fleshlight.com/Madisonivy
                        location:
                          type: string
                          example: CannaBliss
                        wishlist:
                          type: string
                          example: null
                          nullable: true
                        about:
                          type: string
                          example: <p>My wish in life is to be your personal lil fuck toy. WELCOME to my
                            naughty corner of the world. <br /> I hope you’ll
                            love my extremely up-close and personal POVs. I want
                            to give you a true feeling of being with me. <br />
                            Let me tease you and please you.<br /> Command me,
                            Master. For I am your little pet. <br /> And I am
                            waiting… 😈💦<br /><br /> I absolutely love
                            suggestions, so please feel free to send me a DM
                            with ideas! I always try to include as much as
                            possibles 💋<br /> 🚨Also about my page
                            👇👇👇👇👇👇👇👇<br /><br />
                            ...............................................................................................<br
                            /> 💖 Custom Video Contest is returning soon!!!<br
                            /> (Watch page for details)<br /> 💙Tipping is NEVER
                            required. <br /> (But because my page is free, I’m
                            starting to only respond to messages with tips. I’m
                            very sorry about this, but for the past 5 years I’ve
                            answered every single message. And they’re just
                            isn’t enough time in the day.)  <br /> Xoxo<br
                            />     Ur little fuck toy,<br />           </p>
                        last_seen_at:
                          type: string
                          example: null
                          nullable: true
                        is_performer:
                          type: boolean
                          example: true
                        is_real_performer:
                          type: boolean
                          example: true
                        is_adult_content:
                          type: boolean
                          example: false
                        bundles:
                          type: string
                          example: null
                          nullable: true
                        instagram:
                          type: string
                          example: null
                          nullable: true
                        twitter:
                          type: string
                          example: null
                          nullable: true
                        tiktok:
                          type: string
                          example: null
                          nullable: true
                        facebook:
                          type: string
                          example: null
                          nullable: true
                        promotions:
                          type: string
                          example: null
                          nullable: true
                        join_date:
                          type: string
                          example: 2018-11-11T00:00:00.000000Z
                        fansly:
                          type: string
                          example: null
                          nullable: true
                        pornhub:
                          type: string
                          example: null
                          nullable: true
                        manyvids:
                          type: string
                          example: null
                          nullable: true
                  _pagination:
                    type: object
                    properties:
                      total_results:
                        type: integer
                        example: 10000
                      next_cursor:
                        type: string
                        example: WzEsIjEwIl0=
                      next_page_url:
                        type: string
                        example: https://app.onlyfansapi.com/api/search?limit=50&cursor=WzEsIjEwIl0%3D
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 115530
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49998
      tags:
        - Public Profiles
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Count Queue Items (/api-reference/queue/count-queue-items)

Count posts and messages in the queue.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/queue/counts
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/queue/counts:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Count Queue Items
      operationId: countQueueItems
      description: Count posts and messages in the queue.
      parameters:
        - in: query
          name: publishDateStart
          description: Earliest publish date to count from (must be at least today)
          example: 2025-01-01
          required: true
          schema:
            type: string
            description: Earliest publish date to count from (must be at least today)
            example: 2025-01-01
        - in: query
          name: publishDateEnd
          description: Latest publish date to count to
          example: 2025-01-01
          required: true
          schema:
            type: string
            description: Latest publish date to count to
            example: 2025-01-01
        - in: query
          name: timezone
          description: Time timezone of the provided dates. [View available timezone
            values](https://www.php.net/manual/en/timezones.php)
          example: Europe/Prague
          required: true
          schema:
            type: string
            description: Time timezone of the provided dates. [View available timezone
              values](https://www.php.net/manual/en/timezones.php)
            example: Europe/Prague
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      2025-01-01:
                        post: 2
                      2025-01-02:
                        post: 3
                        chat: 4
                    syncInProcess: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999950
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49985
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: object
                        properties:
                          2025-01-01:
                            type: object
                            properties:
                              post:
                                type: integer
                                example: 2
                          2025-01-02:
                            type: object
                            properties:
                              post:
                                type: integer
                                example: 3
                              chat:
                                type: integer
                                example: 4
                      syncInProcess:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999950
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49985
      tags:
        - Queue
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Queue Items (/api-reference/queue/list-queue-items)

List posts and messages in the queue.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/queue
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/queue:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Queue Items
      operationId: listQueueItems
      description: List posts and messages in the queue.
      parameters:
        - in: query
          name: publishDateStart
          description: Earliest publish date to return (must be at least today)
          example: 2025-01-01
          required: true
          schema:
            type: string
            description: Earliest publish date to return (must be at least today)
            example: 2025-01-01
        - in: query
          name: publishDateEnd
          description: Latest publish date to return
          example: 2025-01-01
          required: true
          schema:
            type: string
            description: Latest publish date to return
            example: 2025-01-01
        - in: query
          name: timezone
          description: Time timezone of the provided dates. [View available timezone
            values](https://www.php.net/manual/en/timezones.php)
          example: Europe/Prague
          required: true
          schema:
            type: string
            description: Time timezone of the provided dates. [View available timezone
              values](https://www.php.net/manual/en/timezones.php)
            example: Europe/Prague
        - in: query
          name: limit
          description: Maximum number of queue items to return (default = 20)
          example: 20
          required: true
          schema:
            type: integer
            description: Maximum number of queue items to return (default = 20)
            example: 20
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - id: 123
                        type: chat
                        publishDateTime: 2025-01-01T01:01:01+01:01
                        createdDateTime: 2025-01-01T01:01:01+01:01
                        entity:
                          responseType: message
                          id: 123
                          text: <p>Text</p>
                          rawText: Text
                          giphyId: null
                          lockedText: false
                          isNew: true
                          isFree: true
                          isOpened: false
                          price: 0
                          isMediaReady: true
                          mediaCount: 0
                          media: []
                          previews: []
                          createdAt: 2025-01-01T01:01:01+01:01
                          changedAt: 2025-01-01T01:01:01+01:01
                          scheduledAt: 2025-01-01T01:01:01+01:01
                          isTip: false
                          cancelSeconds: 1000000
                          isLiked: false
                          canPurchase: false
                          isMarkdownDisabled: true
                          releaseForms: []
                          userLists:
                            - fans
                          sentRulesType: list
                          sentRulesExtra: Fans
                          isFromQueue: true
                          queueId: 123
                          canUnsendQueue: true
                          unsendSecondsQueue: 1000000
                      - id: 123
                        type: post
                        publishDateTime: 2025-01-01T01:01:01+01:01
                        createdDateTime: 2025-01-01T01:01:01+01:01
                        entity:
                          responseType: post
                          id: 123
                          postedAt: 2025-01-01T01:01:01+01:01
                          postedAtPrecise: "1234567890.000000"
                          text: Text
                          isMarkdownDisabled: true
                          canDelete: true
                          canEdit: true
                          isMediaReady: true
                          isOpened: true
                          canToggleFavorite: true
                          tipsAmount: $0
                          rawText: Text
                          canViewMedia: true
                    syncInProcess: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999953
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 994
                      remaining_day: 49988
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - id: 123
                            type: chat
                            publishDateTime: 2025-01-01T01:01:01+01:01
                            createdDateTime: 2025-01-01T01:01:01+01:01
                            entity:
                              responseType: message
                              id: 123
                              text: <p>Text</p>
                              rawText: Text
                              giphyId: null
                              lockedText: false
                              isNew: true
                              isFree: true
                              isOpened: false
                              price: 0
                              isMediaReady: true
                              mediaCount: 0
                              media: []
                              previews: []
                              createdAt: 2025-01-01T01:01:01+01:01
                              changedAt: 2025-01-01T01:01:01+01:01
                              scheduledAt: 2025-01-01T01:01:01+01:01
                              isTip: false
                              cancelSeconds: 1000000
                              isLiked: false
                              canPurchase: false
                              isMarkdownDisabled: true
                              releaseForms: []
                              userLists:
                                - fans
                              sentRulesType: list
                              sentRulesExtra: Fans
                              isFromQueue: true
                              queueId: 123
                              canUnsendQueue: true
                              unsendSecondsQueue: 1000000
                          - id: 123
                            type: post
                            publishDateTime: 2025-01-01T01:01:01+01:01
                            createdDateTime: 2025-01-01T01:01:01+01:01
                            entity:
                              responseType: post
                              id: 123
                              postedAt: 2025-01-01T01:01:01+01:01
                              postedAtPrecise: "1234567890.000000"
                              text: Text
                              isMarkdownDisabled: true
                              canDelete: true
                              canEdit: true
                              isMediaReady: true
                              isOpened: true
                              canToggleFavorite: true
                              tipsAmount: $0
                              rawText: Text
                              canViewMedia: true
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            type:
                              type: string
                              example: chat
                            publishDateTime:
                              type: string
                              example: 2025-01-01T01:01:01+01:01
                            createdDateTime:
                              type: string
                              example: 2025-01-01T01:01:01+01:01
                            entity:
                              type: object
                              properties:
                                responseType:
                                  type: string
                                  example: message
                                id:
                                  type: integer
                                  example: 123
                                text:
                                  type: string
                                  example: <p>Text</p>
                                rawText:
                                  type: string
                                  example: Text
                                giphyId:
                                  type: string
                                  example: null
                                  nullable: true
                                lockedText:
                                  type: boolean
                                  example: false
                                isNew:
                                  type: boolean
                                  example: true
                                isFree:
                                  type: boolean
                                  example: true
                                isOpened:
                                  type: boolean
                                  example: false
                                price:
                                  type: integer
                                  example: 0
                                isMediaReady:
                                  type: boolean
                                  example: true
                                mediaCount:
                                  type: integer
                                  example: 0
                                media:
                                  type: array
                                  example: []
                                previews:
                                  type: array
                                  example: []
                                createdAt:
                                  type: string
                                  example: 2025-01-01T01:01:01+01:01
                                changedAt:
                                  type: string
                                  example: 2025-01-01T01:01:01+01:01
                                scheduledAt:
                                  type: string
                                  example: 2025-01-01T01:01:01+01:01
                                isTip:
                                  type: boolean
                                  example: false
                                cancelSeconds:
                                  type: integer
                                  example: 1000000
                                isLiked:
                                  type: boolean
                                  example: false
                                canPurchase:
                                  type: boolean
                                  example: false
                                isMarkdownDisabled:
                                  type: boolean
                                  example: true
                                releaseForms:
                                  type: array
                                  example: []
                                userLists:
                                  type: array
                                  example:
                                    - fans
                                  items:
                                    type: string
                                sentRulesType:
                                  type: string
                                  example: list
                                sentRulesExtra:
                                  type: string
                                  example: Fans
                                isFromQueue:
                                  type: boolean
                                  example: true
                                queueId:
                                  type: integer
                                  example: 123
                                canUnsendQueue:
                                  type: boolean
                                  example: true
                                unsendSecondsQueue:
                                  type: integer
                                  example: 1000000
                      syncInProcess:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999953
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 994
                          remaining_day:
                            type: integer
                            example: 49988
      tags:
        - Queue
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Publish Queue Item (/api-reference/queue/publish-queue-item)

Publish a queue item or "saved for later" item (post or mass message). This means that the item will be sent immediately, regardless of its scheduled date.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml put /api/{account}/queue/{queue_id}/publish
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/queue/{queue_id}/publish:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: queue_id
        description: The ID of the message queue item. Can be retrieved from Queue or
          Mass Messaging endpoints
        example: 1234567890
        required: true
        schema:
          type: string
    put:
      summary: Publish Queue Item
      operationId: publishQueueItem
      description: Publish a queue item or "saved for later" item (post or mass
        message). This means that the item will be sent immediately, regardless
        of its scheduled date.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999916
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49937
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999916
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49937
      tags:
        - Queue
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Create Invitation Link (/api-reference/release-forms/create-invitation-link)

Create a new invitation link for release forms.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/release-forms/create-invitation-link
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/release-forms/create-invitation-link:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Create Invitation Link
      operationId: createInvitationLink
      description: Create a new invitation link for release forms.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 5000003
                    type: guest
                    name: Collab Example - 24/7
                    token: exampleInvitationToken1234567890
                    date: 2026-03-10T12:15:03+00:00
                    invitationUrl: https://onlyfans.com?rfguesttoken=exampleInvitationToken1234567890
                    user:
                      view: t
                      id: 100000001
                      name: Example Creator
                      username: examplecreator
                      isVerified: true
                      isDeleted: false
                      isActive: true
                      avatar: https://public.onlyfans.com/files/example/avatar.jpg
                      avatarThumbs:
                        c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/example/avatar.jpg
                        c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/example/avatar.jpg
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999839
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49997
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 5000003
                      type:
                        type: string
                        example: guest
                      name:
                        type: string
                        example: Collab Example - 24/7
                      token:
                        type: string
                        example: exampleInvitationToken1234567890
                      date:
                        type: string
                        example: 2026-03-10T12:15:03+00:00
                      invitationUrl:
                        type: string
                        example: https://onlyfans.com?rfguesttoken=exampleInvitationToken1234567890
                      user:
                        type: object
                        properties:
                          view:
                            type: string
                            example: t
                          id:
                            type: integer
                            example: 100000001
                          name:
                            type: string
                            example: Example Creator
                          username:
                            type: string
                            example: examplecreator
                          isVerified:
                            type: boolean
                            example: true
                          isDeleted:
                            type: boolean
                            example: false
                          isActive:
                            type: boolean
                            example: true
                          avatar:
                            type: string
                            example: https://public.onlyfans.com/files/example/avatar.jpg
                          avatarThumbs:
                            type: object
                            properties:
                              c50:
                                type: string
                                example: https://thumbs.onlyfans.com/public/files/thumbs/c50/example/avatar.jpg
                              c144:
                                type: string
                                example: https://thumbs.onlyfans.com/public/files/thumbs/c144/example/avatar.jpg
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999839
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49997
        "400":
          description: Validation error from OnlyFans, e.g. duplicate name
          content:
            application/json:
              schema:
                type: object
                example:
                  error: ONLYFANS_COM_ERROR
                  message: Bad Request - The request could not be understood by the server.
                  description: This error happened most probably because of a bug in the
                    OnlyFans.com API or you sent wrong parameters (like a
                    non-existing user id).
                  onlyfans_response:
                    status: 400
                    body:
                      error:
                        code: 0
                        message: Name already in use
                      errors:
                        name:
                          - Name already in use
                properties:
                  error:
                    type: string
                    example: ONLYFANS_COM_ERROR
                  message:
                    type: string
                    example: Bad Request - The request could not be understood by the server.
                  description:
                    type: string
                    example: This error happened most probably because of a bug in the OnlyFans.com
                      API or you sent wrong parameters (like a non-existing user
                      id).
                  onlyfans_response:
                    type: object
                    properties:
                      status:
                        type: integer
                        example: 400
                      body:
                        type: object
                        properties:
                          error:
                            type: object
                            properties:
                              code:
                                type: integer
                                example: 0
                              message:
                                type: string
                                example: Name already in use
                          errors:
                            type: object
                            properties:
                              name:
                                type: array
                                example:
                                  - Name already in use
                                items:
                                  type: string
      tags:
        - Release Forms
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The name of the invitation link.
                  example: Collab Sebastian - 24/7
              required:
                - name
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Create Release Form (/api-reference/release-forms/create-release-form)

Create a new release form link.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/release-forms/create-release-form
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/release-forms/create-release-form:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Create Release Form
      operationId: createReleaseForm
      description: Create a new release form link.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 5000004
                    type: link
                    name: Example Release Form
                    createdAt: 2026-03-10T12:19:56+00:00
                    approvedAt: null
                    code: exampleReleaseFormCodeABCDEF1234
                    signature: abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789
                    submissionUrl: https://onlyfans.com/my/release-forms/exampleReleaseFormCodeABCDEF1234?signature=abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789
                    signed: []
                    signersCount: 1
                    user:
                      view: x
                      avatar: https://public.onlyfans.com/files/example/avatar.jpg
                      avatarThumbs:
                        c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/example/avatar.jpg
                        c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/example/avatar.jpg
                      header: https://public.onlyfans.com/files/example/header_image.jpg
                      headerSize:
                        width: 945
                        height: 1260
                      headerThumbs:
                        w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/example/header_image.jpg
                        w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/example/header_image.jpg
                      id: 100000001
                      name: Example Creator
                      username: examplecreator
                      isVerified: true
                      canPayInternal: true
                      tipsEnabled: true
                      tipsMin: 5
                      tipsMinInternal: 1
                      tipsMax: 200
                      subscribePrice: 17.99
                      canTrialSend: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999839
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49997
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 5000004
                      type:
                        type: string
                        example: link
                      name:
                        type: string
                        example: Example Release Form
                      createdAt:
                        type: string
                        example: 2026-03-10T12:19:56+00:00
                      approvedAt:
                        type: string
                        example: null
                        nullable: true
                      code:
                        type: string
                        example: exampleReleaseFormCodeABCDEF1234
                      signature:
                        type: string
                        example: abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789
                      submissionUrl:
                        type: string
                        example: https://onlyfans.com/my/release-forms/exampleReleaseFormCodeABCDEF1234?signature=abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789
                      signed:
                        type: array
                        example: []
                      signersCount:
                        type: integer
                        example: 1
                      user:
                        type: object
                        properties:
                          view:
                            type: string
                            example: x
                          avatar:
                            type: string
                            example: https://public.onlyfans.com/files/example/avatar.jpg
                          avatarThumbs:
                            type: object
                            properties:
                              c50:
                                type: string
                                example: https://thumbs.onlyfans.com/public/files/thumbs/c50/example/avatar.jpg
                              c144:
                                type: string
                                example: https://thumbs.onlyfans.com/public/files/thumbs/c144/example/avatar.jpg
                          header:
                            type: string
                            example: https://public.onlyfans.com/files/example/header_image.jpg
                          headerSize:
                            type: object
                            properties:
                              width:
                                type: integer
                                example: 945
                              height:
                                type: integer
                                example: 1260
                          headerThumbs:
                            type: object
                            properties:
                              w480:
                                type: string
                                example: https://thumbs.onlyfans.com/public/files/thumbs/w480/example/header_image.jpg
                              w760:
                                type: string
                                example: https://thumbs.onlyfans.com/public/files/thumbs/w760/example/header_image.jpg
                          id:
                            type: integer
                            example: 100000001
                          name:
                            type: string
                            example: Example Creator
                          username:
                            type: string
                            example: examplecreator
                          isVerified:
                            type: boolean
                            example: true
                          canPayInternal:
                            type: boolean
                            example: true
                          tipsEnabled:
                            type: boolean
                            example: true
                          tipsMin:
                            type: integer
                            example: 5
                          tipsMinInternal:
                            type: integer
                            example: 1
                          tipsMax:
                            type: integer
                            example: 200
                          subscribePrice:
                            type: number
                            example: 17.99
                          canTrialSend:
                            type: boolean
                            example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999839
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49997
      tags:
        - Release Forms
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The name of the release form.
                  example: Example Release Form
              required:
                - name
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Hide / Unhide Release Form (/api-reference/release-forms/hide-unhide-release-form)

Toggle the visibility of a release form. Returns the new `isHidden` state.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml patch /api/{account}/release-forms/toggle-show
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/release-forms/toggle-show:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    patch:
      summary: Hide / Unhide Release Form
      operationId: hideUnhideReleaseForm
      description: Toggle the visibility of a release form. Returns the new `isHidden`
        state.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    entityId: 5000002
                    entityType: link
                    isHidden: true
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999839
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49997
                properties:
                  data:
                    type: object
                    properties:
                      entityId:
                        type: integer
                        example: 5000002
                      entityType:
                        type: string
                        example: link
                      isHidden:
                        type: boolean
                        example: true
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999839
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49997
      tags:
        - Release Forms
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                entityId:
                  type: integer
                  description: The ID of the release form to hide or unhide.
                  example: 1029961
                entityType:
                  type: string
                  description: "The type of the release form: `link` or `document`."
                  example: link
                  enum:
                    - link
                    - document
              required:
                - entityId
                - entityType
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Mentions (/api-reference/release-forms/list-mentions)

Get a paginated list of mentions: posts where other creators have tagged or mentioned the account in a release form. Pagination is infinite-scroll: follow `_pagination.next_page` (which advances both `offset` and the `fromId` cursor) until it is `null`.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/release-forms/mentions
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/release-forms/mentions:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Mentions
      operationId: listMentions
      description: "Get a paginated list of mentions: posts where other creators have
        tagged or mentioned the account in a release form. Pagination is
        infinite-scroll: follow `_pagination.next_page` (which advances both
        `offset` and the `fromId` cursor) until it is `null`."
      parameters:
        - in: query
          name: limit
          description: Number of mentions to return per page (1-50). Must be at least 1.
            Must not be greater than 50.
          example: 10
          required: false
          schema:
            type: integer
            description: Number of mentions to return per page (1-50). Must be at least 1.
              Must not be greater than 50.
            example: 10
        - in: query
          name: offset
          description: Number of mentions to skip for pagination. Must be at least 0.
          example: 0
          required: false
          schema:
            type: integer
            description: Number of mentions to skip for pagination. Must be at least 0.
            example: 0
        - in: query
          name: fromId
          description: Cursor for infinite-scroll pagination. Use the `lastId` returned by
            the previous page. Prefer following `_pagination.next_page`, which
            sets this automatically.
          example: null
          required: false
          schema:
            type: integer
            description: Cursor for infinite-scroll pagination. Use the `lastId` returned by
              the previous page. Prefer following `_pagination.next_page`, which
              sets this automatically.
            example: null
            nullable: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - id: 9000000002
                        replacePairs:
                          "{BASE_URL}": https://onlyfans.com
                          "{RECIPIENT_EMAIL}": creator@example.com
                          "{RECIPIENT_ID}": 100000001
                          "{RECIPIENT_LOGIN}": examplecreator
                          "{RECIPIENT_NAME}": Example Creator
                          "{RECIPIENT_URL}": https://onlyfans.com/examplecreator
                          "{RELATED_USER_ID}": 200000001
                          "{RELATED_USER_NAME}": Another Creator
                          "{RELATED_USER_LOGIN}": anothercreator
                          "{RELATED_USER_URL}": https://onlyfans.com/anothercreator
                          "{RELATED_USER_AVATAR}": https://thumbs.onlyfans.com/public/files/thumbs/c144/example/avatar.jpg
                          "{RELATED_USER_HAS_AVATAR}": true
                          "{RELATED_USER_SHORT_NAME}": AC
                        createdAt: 2026-06-26T02:09:55+00:00
                        type: user
                        source: text
                        text: mentioned you in a <a
                          href='https://onlyfans.com/8000000002/anothercreator'>post</a>
                        canGoToProfile: true
                        isRead: true
                        user:
                          id: 200000001
                      - id: 9000000001
                        replacePairs:
                          "{BASE_URL}": https://onlyfans.com
                          "{RECIPIENT_EMAIL}": creator@example.com
                          "{RECIPIENT_ID}": 100000001
                          "{RECIPIENT_LOGIN}": examplecreator
                          "{RECIPIENT_NAME}": Example Creator
                          "{RECIPIENT_URL}": https://onlyfans.com/examplecreator
                          "{RELATED_USER_ID}": 200000002
                          "{RELATED_USER_NAME}": Third Creator
                          "{RELATED_USER_LOGIN}": thirdcreator
                          "{RELATED_USER_URL}": https://onlyfans.com/thirdcreator
                          "{RELATED_USER_AVATAR}": https://thumbs.onlyfans.com/public/files/thumbs/c144/example/avatar.jpg
                          "{RELATED_USER_HAS_AVATAR}": true
                          "{RELATED_USER_SHORT_NAME}": TC
                        createdAt: 2026-06-23T04:28:11+00:00
                        type: user
                        source: tag
                        text: mentioned you in a <a
                          href='https://onlyfans.com/8000000001/thirdcreator'>post</a>
                        canGoToProfile: true
                        isRead: true
                        user:
                          id: 200000002
                    hasMore: true
                    lastId: 9000000000
                  _pagination:
                    next_page: https://app.onlyfansapi.com/api/acct_abc123/release-forms/mentions?limit=10&offset=10&fromId=9000000000
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999839
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49997
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - id: 9000000002
                            replacePairs:
                              "{BASE_URL}": https://onlyfans.com
                              "{RECIPIENT_EMAIL}": creator@example.com
                              "{RECIPIENT_ID}": 100000001
                              "{RECIPIENT_LOGIN}": examplecreator
                              "{RECIPIENT_NAME}": Example Creator
                              "{RECIPIENT_URL}": https://onlyfans.com/examplecreator
                              "{RELATED_USER_ID}": 200000001
                              "{RELATED_USER_NAME}": Another Creator
                              "{RELATED_USER_LOGIN}": anothercreator
                              "{RELATED_USER_URL}": https://onlyfans.com/anothercreator
                              "{RELATED_USER_AVATAR}": https://thumbs.onlyfans.com/public/files/thumbs/c144/example/avatar.jpg
                              "{RELATED_USER_HAS_AVATAR}": true
                              "{RELATED_USER_SHORT_NAME}": AC
                            createdAt: 2026-06-26T02:09:55+00:00
                            type: user
                            source: text
                            text: mentioned you in a <a
                              href='https://onlyfans.com/8000000002/anothercreator'>post</a>
                            canGoToProfile: true
                            isRead: true
                            user:
                              id: 200000001
                          - id: 9000000001
                            replacePairs:
                              "{BASE_URL}": https://onlyfans.com
                              "{RECIPIENT_EMAIL}": creator@example.com
                              "{RECIPIENT_ID}": 100000001
                              "{RECIPIENT_LOGIN}": examplecreator
                              "{RECIPIENT_NAME}": Example Creator
                              "{RECIPIENT_URL}": https://onlyfans.com/examplecreator
                              "{RELATED_USER_ID}": 200000002
                              "{RELATED_USER_NAME}": Third Creator
                              "{RELATED_USER_LOGIN}": thirdcreator
                              "{RELATED_USER_URL}": https://onlyfans.com/thirdcreator
                              "{RELATED_USER_AVATAR}": https://thumbs.onlyfans.com/public/files/thumbs/c144/example/avatar.jpg
                              "{RELATED_USER_HAS_AVATAR}": true
                              "{RELATED_USER_SHORT_NAME}": TC
                            createdAt: 2026-06-23T04:28:11+00:00
                            type: user
                            source: tag
                            text: mentioned you in a <a
                              href='https://onlyfans.com/8000000001/thirdcreator'>post</a>
                            canGoToProfile: true
                            isRead: true
                            user:
                              id: 200000002
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 9000000002
                            replacePairs:
                              type: object
                              properties:
                                "{BASE_URL}":
                                  type: string
                                  example: https://onlyfans.com
                                "{RECIPIENT_EMAIL}":
                                  type: string
                                  example: creator@example.com
                                "{RECIPIENT_ID}":
                                  type: integer
                                  example: 100000001
                                "{RECIPIENT_LOGIN}":
                                  type: string
                                  example: examplecreator
                                "{RECIPIENT_NAME}":
                                  type: string
                                  example: Example Creator
                                "{RECIPIENT_URL}":
                                  type: string
                                  example: https://onlyfans.com/examplecreator
                                "{RELATED_USER_ID}":
                                  type: integer
                                  example: 200000001
                                "{RELATED_USER_NAME}":
                                  type: string
                                  example: Another Creator
                                "{RELATED_USER_LOGIN}":
                                  type: string
                                  example: anothercreator
                                "{RELATED_USER_URL}":
                                  type: string
                                  example: https://onlyfans.com/anothercreator
                                "{RELATED_USER_AVATAR}":
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/c144/example/avatar.jpg
                                "{RELATED_USER_HAS_AVATAR}":
                                  type: boolean
                                  example: true
                                "{RELATED_USER_SHORT_NAME}":
                                  type: string
                                  example: AC
                            createdAt:
                              type: string
                              example: 2026-06-26T02:09:55+00:00
                            type:
                              type: string
                              example: user
                            source:
                              type: string
                              example: text
                            text:
                              type: string
                              example: mentioned you in a <a
                                href='https://onlyfans.com/8000000002/anothercreator'>post</a>
                            canGoToProfile:
                              type: boolean
                              example: true
                            isRead:
                              type: boolean
                              example: true
                            user:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 200000001
                      hasMore:
                        type: boolean
                        example: true
                      lastId:
                        type: integer
                        example: 9000000000
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: https://app.onlyfansapi.com/api/acct_abc123/release-forms/mentions?limit=10&offset=10&fromId=9000000000
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999839
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49997
      tags:
        - Release Forms
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Release Forms (/api-reference/release-forms/list-release-forms)

Get a paginated list of release forms for the account. Use `offset` and `limit` for pagination, following `_pagination.next_page` until it is `null`. Optionally filter with `filter`, sort with `sort`/`sortDirection`, or search by `name`.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/release-forms
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/release-forms:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Release Forms
      operationId: listReleaseForms
      description: Get a paginated list of release forms for the account. Use `offset`
        and `limit` for pagination, following `_pagination.next_page` until it
        is `null`. Optionally filter with `filter`, sort with
        `sort`/`sortDirection`, or search by `name`.
      parameters:
        - in: query
          name: limit
          description: Number of release forms to return per page (1-50). Must be at least
            1. Must not be greater than 50.
          example: 10
          required: false
          schema:
            type: integer
            description: Number of release forms to return per page (1-50). Must be at least
              1. Must not be greater than 50.
            example: 10
        - in: query
          name: offset
          description: Number of release forms to skip for pagination. Must be at least 0.
          example: 0
          required: false
          schema:
            type: integer
            description: Number of release forms to skip for pagination. Must be at least 0.
            example: 0
        - in: query
          name: filter
          description: "Filter release forms by state: `all` or `pending`."
          example: all
          required: false
          schema:
            type: string
            description: "Filter release forms by state: `all` or `pending`."
            example: all
            enum:
              - all
              - pending
            nullable: true
        - in: query
          name: sort
          description: "Sort field: `date` or `name`."
          example: date
          required: false
          schema:
            type: string
            description: "Sort field: `date` or `name`."
            example: date
            enum:
              - date
              - name
            nullable: true
        - in: query
          name: sortDirection
          description: "Sort direction: `desc` or `asc`."
          example: desc
          required: false
          schema:
            type: string
            description: "Sort direction: `desc` or `asc`."
            example: desc
            enum:
              - desc
              - asc
            nullable: true
        - in: query
          name: name
          description: Search release forms by name.
          example: null
          required: false
          schema:
            type: string
            description: Search release forms by name.
            example: null
            nullable: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    items:
                      - id: 5000001
                        type: document
                        name: Example Creator
                        user_partner_id: 300000001
                        code: null
                        date: 2023-01-09 03:53:56
                        approve_date: 2023-01-09 03:55:23
                        last_changed: 2026-06-26 06:33:35
                        status: approved
                        hiddenForRf: false
                        user_name: null
                        hasUser: true
                      - id: 5000002
                        type: link
                        name: Collab Example - 24/7
                        user_partner_id: null
                        code: exampleReleaseFormCode1234567890
                        date: 2026-03-10 12:19:56
                        approve_date: null
                        last_changed: 2026-03-10 12:19:56
                        status: pending
                        hiddenForRf: false
                        user_name: null
                        hasUser: false
                    hasMore: true
                  _pagination:
                    next_page: https://app.onlyfansapi.com/api/acct_abc123/release-forms?limit=10&offset=10
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999839
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49997
                properties:
                  data:
                    type: object
                    properties:
                      items:
                        type: array
                        example:
                          - id: 5000001
                            type: document
                            name: Example Creator
                            user_partner_id: 300000001
                            code: null
                            date: 2023-01-09 03:53:56
                            approve_date: 2023-01-09 03:55:23
                            last_changed: 2026-06-26 06:33:35
                            status: approved
                            hiddenForRf: false
                            user_name: null
                            hasUser: true
                          - id: 5000002
                            type: link
                            name: Collab Example - 24/7
                            user_partner_id: null
                            code: exampleReleaseFormCode1234567890
                            date: 2026-03-10 12:19:56
                            approve_date: null
                            last_changed: 2026-03-10 12:19:56
                            status: pending
                            hiddenForRf: false
                            user_name: null
                            hasUser: false
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 5000001
                            type:
                              type: string
                              example: document
                            name:
                              type: string
                              example: Example Creator
                            user_partner_id:
                              type: integer
                              example: 300000001
                            code:
                              type: string
                              example: null
                              nullable: true
                            date:
                              type: string
                              example: 2023-01-09 03:53:56
                            approve_date:
                              type: string
                              example: 2023-01-09 03:55:23
                            last_changed:
                              type: string
                              example: 2026-06-26 06:33:35
                            status:
                              type: string
                              example: approved
                            hiddenForRf:
                              type: boolean
                              example: false
                            user_name:
                              type: string
                              example: null
                              nullable: true
                            hasUser:
                              type: boolean
                              example: true
                      hasMore:
                        type: boolean
                        example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: https://app.onlyfansapi.com/api/acct_abc123/release-forms?limit=10&offset=10
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999839
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49997
      tags:
        - Release Forms
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Taggable Users (/api-reference/release-forms/list-taggable-users)

Get a paginated list of users that can be tagged in release forms. These are verified creators who have signed release forms to appear in your content. Use `offset` and `limit` for pagination, following `_pagination.next_page` until it is `null`.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/release-forms/taggable-users
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/release-forms/taggable-users:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Taggable Users
      operationId: listTaggableUsers
      description: Get a paginated list of users that can be tagged in release forms.
        These are verified creators who have signed release forms to appear in
        your content. Use `offset` and `limit` for pagination, following
        `_pagination.next_page` until it is `null`.
      parameters:
        - in: query
          name: limit
          description: Number of users to return per page (1-50). Must be at least 1. Must
            not be greater than 50.
          example: 50
          required: false
          schema:
            type: integer
            description: Number of users to return per page (1-50). Must be at least 1. Must
              not be greater than 50.
            example: 50
        - in: query
          name: offset
          description: Number of users to skip for pagination. Must be at least 0.
          example: 0
          required: false
          schema:
            type: integer
            description: Number of users to skip for pagination. Must be at least 0.
            example: 0
        - in: query
          name: filter
          description: "Filter users by type: `all` or `pending`."
          example: all
          required: false
          schema:
            type: string
            description: "Filter users by type: `all` or `pending`."
            example: all
            enum:
              - all
              - pending
            nullable: true
        - in: query
          name: sort
          description: "Sort field: `date` or `name`."
          example: date
          required: false
          schema:
            type: string
            description: "Sort field: `date` or `name`."
            example: date
            enum:
              - date
              - name
            nullable: true
        - in: query
          name: sortDirection
          description: "Sort direction: `desc` or `asc`."
          example: desc
          required: false
          schema:
            type: string
            description: "Sort direction: `desc` or `asc`."
            example: desc
            enum:
              - desc
              - asc
            nullable: true
        - in: query
          name: name
          description: Filter users by name or username.
          example: null
          required: false
          schema:
            type: string
            description: Filter users by name or username.
            example: null
            nullable: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    items:
                      - id: 26898170
                        name: Example User
                        type: user
                        user:
                          view: tu
                          id: 26898170
                          name: Example User
                          username: exampleuser
                          isVerified: true
                          avatar: https://public.onlyfans.com/files/.../26898170/avatar.jpg
                          avatarThumbs:
                            c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/.../26898170/avatar.jpg
                            c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/.../26898170/avatar.jpg
                          ivStatus: approved
                          isFromGuest: false
                          hiddenForRf: false
                      - id: 43888127
                        name: Another Creator
                        type: user
                        user:
                          view: tu
                          id: 43888127
                          name: Another Creator
                          username: anothercreator
                          isVerified: true
                          avatar: https://public.onlyfans.com/files/.../43888127/avatar.jpg
                          avatarThumbs:
                            c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/.../43888127/avatar.jpg
                            c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/.../43888127/avatar.jpg
                          ivStatus: approved
                          isFromGuest: true
                          hiddenForRf: false
                  _pagination:
                    next_page: https://app.onlyfansapi.com/api/acct_abc123/release-forms/taggable-users?limit=50&offset=50
                    notice: OnlyFans does not return a reliable `hasMore` flag for this endpoint, so
                      pagination is inferred from page fullness. Keep requesting
                      `next_page` until it is `null`.
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999839
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49997
                properties:
                  data:
                    type: object
                    properties:
                      items:
                        type: array
                        example:
                          - id: 26898170
                            name: Example User
                            type: user
                            user:
                              view: tu
                              id: 26898170
                              name: Example User
                              username: exampleuser
                              isVerified: true
                              avatar: https://public.onlyfans.com/files/.../26898170/avatar.jpg
                              avatarThumbs:
                                c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/.../26898170/avatar.jpg
                                c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/.../26898170/avatar.jpg
                              ivStatus: approved
                              isFromGuest: false
                              hiddenForRf: false
                          - id: 43888127
                            name: Another Creator
                            type: user
                            user:
                              view: tu
                              id: 43888127
                              name: Another Creator
                              username: anothercreator
                              isVerified: true
                              avatar: https://public.onlyfans.com/files/.../43888127/avatar.jpg
                              avatarThumbs:
                                c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/.../43888127/avatar.jpg
                                c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/.../43888127/avatar.jpg
                              ivStatus: approved
                              isFromGuest: true
                              hiddenForRf: false
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 26898170
                            name:
                              type: string
                              example: Example User
                            type:
                              type: string
                              example: user
                            user:
                              type: object
                              properties:
                                view:
                                  type: string
                                  example: tu
                                id:
                                  type: integer
                                  example: 26898170
                                name:
                                  type: string
                                  example: Example User
                                username:
                                  type: string
                                  example: exampleuser
                                isVerified:
                                  type: boolean
                                  example: true
                                avatar:
                                  type: string
                                  example: https://public.onlyfans.com/files/.../26898170/avatar.jpg
                                avatarThumbs:
                                  type: object
                                  properties:
                                    c50:
                                      type: string
                                      example: https://thumbs.onlyfans.com/public/files/thumbs/c50/.../26898170/avatar.jpg
                                    c144:
                                      type: string
                                      example: https://thumbs.onlyfans.com/public/files/thumbs/c144/.../26898170/avatar.jpg
                                ivStatus:
                                  type: string
                                  example: approved
                                isFromGuest:
                                  type: boolean
                                  example: false
                                hiddenForRf:
                                  type: boolean
                                  example: false
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: https://app.onlyfansapi.com/api/acct_abc123/release-forms/taggable-users?limit=50&offset=50
                      notice:
                        type: string
                        example: OnlyFans does not return a reliable `hasMore` flag for this endpoint,
                          so pagination is inferred from page fullness. Keep
                          requesting `next_page` until it is `null`.
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999839
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49997
      tags:
        - Release Forms
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Rename Release Form (/api-reference/release-forms/rename-release-form)

Rename a release form.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml patch /api/{account}/release-forms/rename
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/release-forms/rename:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    patch:
      summary: Rename Release Form
      operationId: renameReleaseForm
      description: Rename a release form.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 5000002
                    name: Collab Example - Renamed
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999839
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49997
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 5000002
                      name:
                        type: string
                        example: Collab Example - Renamed
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999839
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49997
      tags:
        - Release Forms
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                entityId:
                  type: integer
                  description: The ID of the release form to rename.
                  example: 1029961
                name:
                  type: string
                  description: The new name for the release form.
                  example: Collab Sebastian - Renamed
              required:
                - entityId
                - name
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Disable Automatic Posting (/api-reference/saved-for-later-posts/disable-automatic-posting)

Disable automatic posting of Saved For Later posts.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml patch /api/{account}/saved-for-later/posts/settings/disable-automatic-posting
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/saved-for-later/posts/settings/disable-automatic-posting:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    patch:
      summary: Disable Automatic Posting
      operationId: disableAutomaticPosting
      description: Disable automatic posting of Saved For Later posts.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999938
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49967
                properties:
                  data:
                    type: array
                    example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999938
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49967
      tags:
        - Saved For Later (Posts)
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Enable/Update Automatic Posting (/api-reference/saved-for-later-posts/enable-update-automatic-posting)

Enable or update automatic posting of Saved For Later posts.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml patch /api/{account}/saved-for-later/posts/settings/enable-or-update-automatic-posting
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/saved-for-later/posts/settings/enable-or-update-automatic-posting:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    patch:
      summary: Enable/Update Automatic Posting
      operationId: enableUpdateAutomaticPosting
      description: Enable or update automatic posting of Saved For Later posts.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    period: 6
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999940
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 997
                      remaining_day: 49969
                properties:
                  data:
                    type: object
                    properties:
                      period:
                        type: integer
                        example: 6
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999940
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 49969
      tags:
        - Saved For Later (Posts)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                period:
                  type: integer
                  description: The automatic posting interval (in hours)
                  example: 6
                  enum:
                    - 6
                    - 12
                    - 24
                    - 48
              required:
                - period
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Post Settings (/api-reference/saved-for-later-posts/get-post-settings)

Get the Saved For Later post settings.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/saved-for-later/posts/settings
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/saved-for-later/posts/settings:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Post Settings
      operationId: getPostSettings
      description: Get the Saved For Later post settings.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    currentCode: 6
                    isEnabled: false
                    options:
                      - 6
                      - 12
                      - 24
                      - 48
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999941
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49972
                properties:
                  data:
                    type: object
                    properties:
                      currentCode:
                        type: integer
                        example: 6
                      isEnabled:
                        type: boolean
                        example: false
                      options:
                        type: array
                        example:
                          - 6
                          - 12
                          - 24
                          - 48
                        items:
                          type: integer
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999941
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49972
      tags:
        - Saved For Later (Posts)
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Saved For Later Posts (/api-reference/saved-for-later-posts/list-saved-for-later-posts)

List all posts that are marked as "Save For Later".

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/saved-for-later/posts
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/saved-for-later/posts:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Saved For Later Posts
      operationId: listSavedForLaterPosts
      description: List all posts that are marked as "Save For Later".
      parameters:
        - in: query
          name: limit
          description: Maximum number of posts to return (default = 10)
          example: 10
          required: true
          schema:
            type: integer
            description: Maximum number of posts to return (default = 10)
            example: 10
        - in: query
          name: offset
          description: Offset for pagination (default = 0)
          example: 0
          required: true
          schema:
            type: integer
            description: Offset for pagination (default = 0)
            example: 0
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - id: 123
                        type: post
                        publishDateTime: null
                        createdDateTime: 2025-01-01T01:01:01+01:01
                        entity:
                          responseType: post
                          id: 123
                          postedAt: 2025-01-01T01:01:01+01:01
                          postedAtPrecise: 2025-01-01T01:01:01+01:01
                          text: <p>Text</p>
                          isMarkdownDisabled: true
                          canDelete: true
                          canEdit: true
                          isMediaReady: true
                          isOpened: true
                          canToggleFavorite: true
                          tipsAmount: $0
                          isPublishedWithPeriod: true
                          rawText: Text
                          canViewMedia: true
                    hasMore: false
                    syncInProcess: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999942
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49973
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - id: 123
                            type: post
                            publishDateTime: null
                            createdDateTime: 2025-01-01T01:01:01+01:01
                            entity:
                              responseType: post
                              id: 123
                              postedAt: 2025-01-01T01:01:01+01:01
                              postedAtPrecise: 2025-01-01T01:01:01+01:01
                              text: <p>Text</p>
                              isMarkdownDisabled: true
                              canDelete: true
                              canEdit: true
                              isMediaReady: true
                              isOpened: true
                              canToggleFavorite: true
                              tipsAmount: $0
                              isPublishedWithPeriod: true
                              rawText: Text
                              canViewMedia: true
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            type:
                              type: string
                              example: post
                            publishDateTime:
                              type: string
                              example: null
                              nullable: true
                            createdDateTime:
                              type: string
                              example: 2025-01-01T01:01:01+01:01
                            entity:
                              type: object
                              properties:
                                responseType:
                                  type: string
                                  example: post
                                id:
                                  type: integer
                                  example: 123
                                postedAt:
                                  type: string
                                  example: 2025-01-01T01:01:01+01:01
                                postedAtPrecise:
                                  type: string
                                  example: 2025-01-01T01:01:01+01:01
                                text:
                                  type: string
                                  example: <p>Text</p>
                                isMarkdownDisabled:
                                  type: boolean
                                  example: true
                                canDelete:
                                  type: boolean
                                  example: true
                                canEdit:
                                  type: boolean
                                  example: true
                                isMediaReady:
                                  type: boolean
                                  example: true
                                isOpened:
                                  type: boolean
                                  example: true
                                canToggleFavorite:
                                  type: boolean
                                  example: true
                                tipsAmount:
                                  type: string
                                  example: $0
                                isPublishedWithPeriod:
                                  type: boolean
                                  example: true
                                rawText:
                                  type: string
                                  example: Text
                                canViewMedia:
                                  type: boolean
                                  example: true
                      hasMore:
                        type: boolean
                        example: false
                      syncInProcess:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999942
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49973
      tags:
        - Saved For Later (Posts)
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Disable Automatic Messaging (/api-reference/saved-for-later-messages/disable-automatic-messaging)

Disable automatic messaging of Saved For Later messages.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml patch /api/{account}/saved-for-later/messages/settings/disable-automatic-messaging
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/saved-for-later/messages/settings/disable-automatic-messaging:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    patch:
      summary: Disable Automatic Messaging
      operationId: disableAutomaticMessaging
      description: Disable automatic messaging of Saved For Later messages.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999932
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 997
                      remaining_day: 49961
                properties:
                  data:
                    type: array
                    example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999932
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 49961
      tags:
        - Saved For Later (Messages)
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Enable/Update Automatic Messaging (/api-reference/saved-for-later-messages/enable-update-automatic-messaging)

Enable or update automatic messaging of Saved For Later messages.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml patch /api/{account}/saved-for-later/messages/settings/enable-or-update-automatic-messaging
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/saved-for-later/messages/settings/enable-or-update-automatic-messaging:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    patch:
      summary: Enable/Update Automatic Messaging
      operationId: enableUpdateAutomaticMessaging
      description: Enable or update automatic messaging of Saved For Later messages.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    period: 12
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999933
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49962
                properties:
                  data:
                    type: object
                    properties:
                      period:
                        type: integer
                        example: 12
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999933
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49962
      tags:
        - Saved For Later (Messages)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                period:
                  type: integer
                  description: The automatic messaging interval (in hours)
                  example: 48
                  enum:
                    - 6
                    - 12
                    - 24
                    - 48
              required:
                - period
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Message Settings (/api-reference/saved-for-later-messages/get-message-settings)

Get the Saved For Later message settings.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/saved-for-later/messages/settings
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/saved-for-later/messages/settings:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Message Settings
      operationId: getMessageSettings
      description: Get the Saved For Later message settings.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    currentCode: 12
                    isEnabled: false
                    options:
                      - 6
                      - 12
                      - 24
                      - 48
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999934
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49963
                properties:
                  data:
                    type: object
                    properties:
                      currentCode:
                        type: integer
                        example: 12
                      isEnabled:
                        type: boolean
                        example: false
                      options:
                        type: array
                        example:
                          - 6
                          - 12
                          - 24
                          - 48
                        items:
                          type: integer
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999934
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49963
      tags:
        - Saved For Later (Messages)
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Saved For Later Messages (/api-reference/saved-for-later-messages/list-saved-for-later-messages)

List all messages that are marked as "Save For Later".

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/saved-for-later/messages
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/saved-for-later/messages:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Saved For Later Messages
      operationId: listSavedForLaterMessages
      description: List all messages that are marked as "Save For Later".
      parameters:
        - in: query
          name: limit
          description: Maximum number of messages to return (default = 10)
          example: 10
          required: true
          schema:
            type: integer
            description: Maximum number of messages to return (default = 10)
            example: 10
        - in: query
          name: offset
          description: Offset for pagination (default = 0)
          example: 0
          required: true
          schema:
            type: integer
            description: Offset for pagination (default = 0)
            example: 0
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - id: 123
                        type: chat
                        publishDateTime: null
                        createdDateTime: 2025-01-01T01:01:01+01:01
                        entity:
                          responseType: message
                          id: 123
                          text: <p>Text</p>
                          rawText: Text
                          giphyId: null
                          lockedText: false
                          isNew: true
                          isFree: true
                          isOpened: false
                          price: 0
                          isMediaReady: true
                          mediaCount: 0
                          media: []
                          previews: []
                          createdAt: 2025-01-01T01:01:01+01:01
                          changedAt: 2025-01-01T01:01:01+01:01
                          scheduledAt: null
                          isTip: false
                          cancelSeconds: 1000000
                          isLiked: false
                          canPurchase: false
                          isMarkdownDisabled: true
                          releaseForms: []
                          userIds:
                            - "123"
                          sentRulesType: user
                          sentRulesExtra: username
                          isFromQueue: true
                          queueId: 123
                          canUnsendQueue: true
                          unsendSecondsQueue: 1000000
                    hasMore: false
                    syncInProcess: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999943
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49974
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - id: 123
                            type: chat
                            publishDateTime: null
                            createdDateTime: 2025-01-01T01:01:01+01:01
                            entity:
                              responseType: message
                              id: 123
                              text: <p>Text</p>
                              rawText: Text
                              giphyId: null
                              lockedText: false
                              isNew: true
                              isFree: true
                              isOpened: false
                              price: 0
                              isMediaReady: true
                              mediaCount: 0
                              media: []
                              previews: []
                              createdAt: 2025-01-01T01:01:01+01:01
                              changedAt: 2025-01-01T01:01:01+01:01
                              scheduledAt: null
                              isTip: false
                              cancelSeconds: 1000000
                              isLiked: false
                              canPurchase: false
                              isMarkdownDisabled: true
                              releaseForms: []
                              userIds:
                                - "123"
                              sentRulesType: user
                              sentRulesExtra: username
                              isFromQueue: true
                              queueId: 123
                              canUnsendQueue: true
                              unsendSecondsQueue: 1000000
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            type:
                              type: string
                              example: chat
                            publishDateTime:
                              type: string
                              example: null
                              nullable: true
                            createdDateTime:
                              type: string
                              example: 2025-01-01T01:01:01+01:01
                            entity:
                              type: object
                              properties:
                                responseType:
                                  type: string
                                  example: message
                                id:
                                  type: integer
                                  example: 123
                                text:
                                  type: string
                                  example: <p>Text</p>
                                rawText:
                                  type: string
                                  example: Text
                                giphyId:
                                  type: string
                                  example: null
                                  nullable: true
                                lockedText:
                                  type: boolean
                                  example: false
                                isNew:
                                  type: boolean
                                  example: true
                                isFree:
                                  type: boolean
                                  example: true
                                isOpened:
                                  type: boolean
                                  example: false
                                price:
                                  type: integer
                                  example: 0
                                isMediaReady:
                                  type: boolean
                                  example: true
                                mediaCount:
                                  type: integer
                                  example: 0
                                media:
                                  type: array
                                  example: []
                                previews:
                                  type: array
                                  example: []
                                createdAt:
                                  type: string
                                  example: 2025-01-01T01:01:01+01:01
                                changedAt:
                                  type: string
                                  example: 2025-01-01T01:01:01+01:01
                                scheduledAt:
                                  type: string
                                  example: null
                                  nullable: true
                                isTip:
                                  type: boolean
                                  example: false
                                cancelSeconds:
                                  type: integer
                                  example: 1000000
                                isLiked:
                                  type: boolean
                                  example: false
                                canPurchase:
                                  type: boolean
                                  example: false
                                isMarkdownDisabled:
                                  type: boolean
                                  example: true
                                releaseForms:
                                  type: array
                                  example: []
                                userIds:
                                  type: array
                                  example:
                                    - "123"
                                  items:
                                    type: string
                                sentRulesType:
                                  type: string
                                  example: user
                                sentRulesExtra:
                                  type: string
                                  example: username
                                isFromQueue:
                                  type: boolean
                                  example: true
                                queueId:
                                  type: integer
                                  example: 123
                                canUnsendQueue:
                                  type: boolean
                                  example: true
                                unsendSecondsQueue:
                                  type: integer
                                  example: 1000000
                      hasMore:
                        type: boolean
                        example: false
                      syncInProcess:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999943
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49974
      tags:
        - Saved For Later (Messages)
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Add Shared Free Trial Link Tags (/api-reference/shared-free-trial-links/add-shared-free-trial-link-tags)

Add tags to a shared Free Trial Link. Existing tags are preserved. Tag namespace is shared with owned Free Trial Links. This is a free endpoint.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/shared-trial-links/{shared_trial_link_id}/tags
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/shared-trial-links/{shared_trial_link_id}/tags:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: shared_trial_link_id
        description: The OnlyFans-side ID of the shared trial link
        example: 123
        required: true
        schema:
          type: integer
    post:
      summary: Add Shared Free Trial Link Tags
      operationId: addSharedFreeTrialLinkTags
      description: Add tags to a shared Free Trial Link. Existing tags are preserved.
        Tag namespace is shared with owned Free Trial Links. This is a free
        endpoint.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    tags:
                      - collab
                      - july
                  _meta:
                    _credits:
                      used: 0
                      balance: 10055833
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      tags:
                        type: array
                        example:
                          - collab
                          - july
                        items:
                          type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 10055833
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Shared Free Trial Links
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tags:
                  type: array
                  description: Array of tag names to add to the shared trial link.
                  example: '["collab", "july"]'
                  items:
                    type: string
              required:
                - tags
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Shared Free Trial Link Tags (/api-reference/shared-free-trial-links/list-shared-free-trial-link-tags)

Get tags for a specific shared Free Trial Link. Tag namespace is shared with owned Free Trial Links. This is a free endpoint.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/shared-trial-links/{shared_trial_link_id}/tags
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/shared-trial-links/{shared_trial_link_id}/tags:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: shared_trial_link_id
        description: The OnlyFans-side ID of the shared trial link
        example: 123
        required: true
        schema:
          type: integer
    get:
      summary: List Shared Free Trial Link Tags
      operationId: listSharedFreeTrialLinkTags
      description: Get tags for a specific shared Free Trial Link. Tag namespace is
        shared with owned Free Trial Links. This is a free endpoint.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    tags:
                      - collab
                      - july
                  _meta:
                    _credits:
                      used: 0
                      balance: 10055833
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      tags:
                        type: array
                        example:
                          - collab
                          - july
                        items:
                          type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 10055833
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Shared Free Trial Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Shared Free Trial Links (/api-reference/shared-free-trial-links/list-shared-free-trial-links)

List all Free Trial Links shared with the account by other OF creators. Calls OnlyFans live and syncs to our cache.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/shared-trial-links
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/shared-trial-links:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Shared Free Trial Links
      operationId: listSharedFreeTrialLinks
      description: List all Free Trial Links shared with the account by other OF
        creators. Calls OnlyFans live and syncs to our cache.
      parameters:
        - in: query
          name: limit
          description: The number of shared trial links to return. Default `10`. Must be
            at least 1. Must not be greater than 100.
          example: 10
          required: false
          schema:
            type: integer
            description: The number of shared trial links to return. Default `10`. Must be
              at least 1. Must not be greater than 100.
            example: 10
        - in: query
          name: offset
          description: The offset used for pagination. Default `0`. Must be at least 0.
          example: 0
          required: false
          schema:
            type: integer
            description: The offset used for pagination. Default `0`. Must be at least 0.
            example: 0
        - in: query
          name: pagination
          description: ""
          example: 1
          required: false
          schema:
            type: integer
            description: ""
            example: 1
            enum:
              - 0
              - 1
        - in: query
          name: synchronous
          description: Wait for the database sync instead of processing it in the
            background.
          example: false
          required: false
          schema:
            type: boolean
            description: Wait for the database sync instead of processing it in the
              background.
            example: false
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - id: 123
                        trialLinkName: Example shared trial link
                        url: https://onlyfans.com/username/trial/abc123
                        subscribeDays: 30
                        subscribeCounts: 0
                        claimCounts: 123
                        clicksCounts: 182
                        expiredAt: null
                        createdAt: 2025-01-01T01:01:01+00:00
                        isFinished: false
                        tags: []
                        owner:
                          id: 123
                          username: username
                          name: Model name
                          avatarThumbUrl: https://thumbs.onlyfans.com/public/files/thumbs/a123/a/aa/aaa/abc123/123/avatar.jpg
                    hasMore: true
                  _pagination:
                    next_page: https://app.onlyfansapi.com/api/acct_abc123/shared-trial-links?limit=10&offset=10
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055833
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - id: 123
                            trialLinkName: Example shared trial link
                            url: https://onlyfans.com/username/trial/abc123
                            subscribeDays: 30
                            subscribeCounts: 0
                            claimCounts: 123
                            clicksCounts: 182
                            expiredAt: null
                            createdAt: 2025-01-01T01:01:01+00:00
                            isFinished: false
                            tags: []
                            owner:
                              id: 123
                              username: username
                              name: Model name
                              avatarThumbUrl: https://thumbs.onlyfans.com/public/files/thumbs/a123/a/aa/aaa/abc123/123/avatar.jpg
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            trialLinkName:
                              type: string
                              example: Example shared trial link
                            url:
                              type: string
                              example: https://onlyfans.com/username/trial/abc123
                            subscribeDays:
                              type: integer
                              example: 30
                            subscribeCounts:
                              type: integer
                              example: 0
                            claimCounts:
                              type: integer
                              example: 123
                            clicksCounts:
                              type: integer
                              example: 182
                            expiredAt:
                              type: string
                              example: null
                              nullable: true
                            createdAt:
                              type: string
                              example: 2025-01-01T01:01:01+00:00
                            isFinished:
                              type: boolean
                              example: false
                            tags:
                              type: array
                              example: []
                            owner:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                username:
                                  type: string
                                  example: username
                                name:
                                  type: string
                                  example: Model name
                                avatarThumbUrl:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/a123/a/aa/aaa/abc123/123/avatar.jpg
                      hasMore:
                        type: boolean
                        example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: https://app.onlyfansapi.com/api/acct_abc123/shared-trial-links?limit=10&offset=10
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055833
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Shared Free Trial Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Remove Shared Free Trial Link Tags (/api-reference/shared-free-trial-links/remove-shared-free-trial-link-tags)

Remove tags from a shared Free Trial Link. Tag namespace is shared with owned Free Trial Links. This is a free endpoint.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/shared-trial-links/{shared_trial_link_id}/tags
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/shared-trial-links/{shared_trial_link_id}/tags:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: shared_trial_link_id
        description: The OnlyFans-side ID of the shared trial link
        example: 123
        required: true
        schema:
          type: integer
    delete:
      summary: Remove Shared Free Trial Link Tags
      operationId: removeSharedFreeTrialLinkTags
      description: Remove tags from a shared Free Trial Link. Tag namespace is shared
        with owned Free Trial Links. This is a free endpoint.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    tags:
                      - july
                  _meta:
                    _credits:
                      used: 0
                      balance: 10055833
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      tags:
                        type: array
                        example:
                          - july
                        items:
                          type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 10055833
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Shared Free Trial Links
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tags:
                  type: array
                  description: Array of tag names to remove from the shared trial link.
                  example: '["collab"]'
                  items:
                    type: string
              required:
                - tags
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Revoke Shared Free Trial Link Access (/api-reference/shared-free-trial-links/revoke-shared-free-trial-link-access)

Revoke the account's access to a shared Free Trial Link. Calls OnlyFans `DELETE /trials/share-access`, then removes the local cache row. The owner keeps the link.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/shared-trial-links/{shared_trial_link_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/shared-trial-links/{shared_trial_link_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: shared_trial_link_id
        description: The OnlyFans-side ID of the shared trial link
        example: 123
        required: true
        schema:
          type: integer
    delete:
      summary: Revoke Shared Free Trial Link Access
      operationId: revokeSharedFreeTrialLinkAccess
      description: Revoke the account's access to a shared Free Trial Link. Calls
        OnlyFans `DELETE /trials/share-access`, then removes the local cache
        row. The owner keeps the link.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055832
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055832
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Shared Free Trial Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Add Social Media Button (/api-reference/settings/add-social-media-button)

Adds a new social media button to the account

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/settings/social-media-buttons
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/settings/social-media-buttons:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Add Social Media Button
      operationId: addSocialMediaButton
      description: Adds a new social media button to the account
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - id: 123
                      sort: 0
                      label: Amazon
                      username: ""
                      socialMedia: amazon
                      link: https://amazon.com/example
                      url: https://amazon.com/example
                      isValid: true
                      clicks: 0
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999959
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49986
                properties:
                  data:
                    type: array
                    example:
                      - id: 123
                        sort: 0
                        label: Amazon
                        username: ""
                        socialMedia: amazon
                        link: https://amazon.com/example
                        url: https://amazon.com/example
                        isValid: true
                        clicks: 0
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 123
                        sort:
                          type: integer
                          example: 0
                        label:
                          type: string
                          example: Amazon
                        username:
                          type: string
                          example: ""
                        socialMedia:
                          type: string
                          example: amazon
                        link:
                          type: string
                          example: https://amazon.com/example
                        url:
                          type: string
                          example: https://amazon.com/example
                        isValid:
                          type: boolean
                          example: true
                        clicks:
                          type: integer
                          example: 0
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999959
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49986
      tags:
        - Settings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                label:
                  type: string
                  description: The button label
                  example: Instagram
                type:
                  type: string
                  description: The button type
                  example: Instagram
                  enum:
                    - instagram
                    - x
                    - facebook
                    - youtube
                    - tiktok
                    - snapchat
                    - amazon
                    - twitch
                    - discord
                    - patreon
                    - pinterest
                    - etsy
                    - bereal
                    - kick
                    - depop
                    - poshmark
                    - vsco
                    - threads
                    - throne
                    - shopltk
                    - oftv
                    - bluesky
                value:
                  type: string
                  description: The button value, either a username or link.
                  example: example_user
              required:
                - label
                - type
                - value
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Check Username Availability (/api-reference/settings/check-username-availability)

Check if a username is taken. Returns `false` if the username is available, `true` if it is already taken.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/settings/username-exists
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/settings/username-exists:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Check Username Availability
      operationId: checkUsernameAvailability
      description: Check if a username is taken. Returns `false` if the username is
        available, `true` if it is already taken.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999972
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999994
                      remaining_day: 49973
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999972
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999994
                          remaining_day:
                            type: integer
                            example: 49973
      tags:
        - Settings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                username:
                  type: string
                  description: The username to check.
                  example: MyNewUsername
              required:
                - username
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Delete Social Media Button (/api-reference/settings/delete-social-media-button)

Deletes a social media button from the account

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/settings/social-media-buttons/{button_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/settings/social-media-buttons/{button_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: button_id
        description: The ID of the social media button to update
        example: 123
        required: true
        schema:
          type: string
    delete:
      summary: Delete Social Media Button
      operationId: deleteSocialMediaButton
      description: Deletes a social media button from the account
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999960
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 996
                      remaining_day: 49987
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999960
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 996
                          remaining_day:
                            type: integer
                            example: 49987
      tags:
        - Settings
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Enable/Disable DRM (/api-reference/settings/enable-disable-drm)

Enable or disable DRM protection for media. DRM Protection helps to protect video content from being copied or downloaded. After you enable it, DRM Protection will be applied to uploads after that date. DRM Protection may limit the ability of fans using older devices to view this video content.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml patch /api/{account}/settings/drm
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/settings/drm:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    patch:
      summary: Enable/Disable DRM
      operationId: enableDisableDRM
      description: Enable or disable DRM protection for media. DRM Protection helps to
        protect video content from being copied or downloaded. After you enable
        it, DRM Protection will be applied to uploads after that date. DRM
        Protection may limit the ability of fans using older devices to view
        this video content.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    init:
                      upload:
                        geoUploadArgs:
                          preset: of_drm
                          protected_preset: of_drm
                          preset_public: of_public
                          preset_png: of_png
                          isDelay: true
                          needThumbs: true
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999969
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999998
                      remaining_day: 49970
                properties:
                  data:
                    type: object
                    properties:
                      init:
                        type: object
                        properties:
                          upload:
                            type: object
                            properties:
                              geoUploadArgs:
                                type: object
                                properties:
                                  preset:
                                    type: string
                                    example: of_drm
                                  protected_preset:
                                    type: string
                                    example: of_drm
                                  preset_public:
                                    type: string
                                    example: of_public
                                  preset_png:
                                    type: string
                                    example: of_png
                                  isDelay:
                                    type: boolean
                                    example: true
                                  needThumbs:
                                    type: boolean
                                    example: true
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999969
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999998
                          remaining_day:
                            type: integer
                            example: 49970
      tags:
        - Settings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                enabled:
                  type: boolean
                  description: Whether DRM protection should be enabled.
                  example: true
              required:
                - enabled
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Enable/Disable Welcome Message (/api-reference/settings/enable-disable-welcome-message)

Enable or disable the automatic welcome message that is sent when someone subscribes.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml patch /api/{account}/settings/welcome-message
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/settings/welcome-message:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    patch:
      summary: Enable/Disable Welcome Message
      operationId: enableDisableWelcomeMessage
      description: Enable or disable the automatic welcome message that is sent when
        someone subscribes.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999969
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999998
                      remaining_day: 49970
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999969
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999998
                          remaining_day:
                            type: integer
                            example: 49970
      tags:
        - Settings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                enabled:
                  type: boolean
                  description: Whether the welcome message should be enabled.
                  example: true
              required:
                - enabled
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Blocked Countries (/api-reference/settings/get-blocked-countries)

Returns the countries blocked from viewing the account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/settings/blocked-countries
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/settings/blocked-countries:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Blocked Countries
      operationId: getBlockedCountries
      description: Returns the countries blocked from viewing the account.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    blockedCountries:
                      - US
                      - RU
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999969
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999998
                      remaining_day: 49970
                properties:
                  data:
                    type: object
                    properties:
                      blockedCountries:
                        type: array
                        example:
                          - US
                          - RU
                        items:
                          type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999969
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999998
                          remaining_day:
                            type: integer
                            example: 49970
      tags:
        - Settings
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get DRM Status (/api-reference/settings/get-drm-status)

Returns whether DRM protection is enabled for media. DRM Protection helps to protect video content from being copied or downloaded. DRM Protection may limit the ability of fans using older devices to view this video content.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/settings/drm
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/settings/drm:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get DRM Status
      operationId: getDRMStatus
      description: Returns whether DRM protection is enabled for media. DRM Protection
        helps to protect video content from being copied or downloaded. DRM
        Protection may limit the ability of fans using older devices to view
        this video content.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    enabled: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999969
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999998
                      remaining_day: 49970
                properties:
                  data:
                    type: object
                    properties:
                      enabled:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999969
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999998
                          remaining_day:
                            type: integer
                            example: 49970
      tags:
        - Settings
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Settings (/api-reference/settings/get-settings)

Returns the account settings

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/settings
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/settings:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Settings
      operationId: getSettings
      description: Returns the account settings
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    isDeleteInitiated: false
                    lastSubscriptionExpiredAt: null
                    streamingObsKey: abc123
                    streamingObsServer: rtmp://route0-dc2.onlyfans.com/live
                    streamingMuxKey: null
                    streamingMuxServer: rtmps://global-live.mux.com:443/app
                    streamingMuxKeyExpiredAt: null
                    activityHubAllowed: false
                    activityHubTokens: []
                    confirmEmailSentAt: 2025-01-01T00:00:00+00:00
                    hideAfterMassMessages: true
                    changelogUpdates: 3
                    showFullTextInEmailNotify: false
                    isPrivate: true
                    blockedCountries: []
                    blockedStates: []
                    blockedIps: []
                    showPostsTips: true
                    recommenderReward: null
                    showFriendsToSubscribers: true
                    showSubscribesOffers: true
                    disableSubscribesOffers: true
                    isEmailNotificationsEnabled: false
                    canAcceptMessageOnlyFromFriends: false
                    isAutoFollowBack: true
                    unfollowAutoFollowBack: false
                    changeEmailStep: null
                    newEmail: null
                    lifeTimeEmailCode: null
                    coStreamingRequestFrom: subscribers
                    hasPaidPosts: false
                    isCoStreamingAllowed: true
                    isMonthlyNewsletters: false
                    strongOtp: false
                    phoneOtp: false
                    appOtp: false
                    isOtpAppConnected: false
                    isOldLoginRedirect: true
                    faceOtp: false
                    canSocialsConnect: true
                    socialsConnects: []
                    importantSubscriptionNotifications: true
                    isOpenseaConnected: false
                    forceFaceOtp: false
                    hasPassword: true
                    canAddSubscriberByBundle:
                      discounts:
                        "0": 0% discount
                        "5": 5% discount
                        "10": 10% discount
                        "15": 15% discount
                        "20": 20% discount
                        "25": 25% discount
                        "30": 30% discount
                        "35": 35% discount
                        "40": 40% discount
                        "45": 45% discount
                        "50": 50% discount
                      durations:
                        "3": 3 months
                        "6": 6 months
                        "12": 12 months
                    bundleMaxPrice: 250
                    canMakeProfileLinks: true
                    isSuggestionsOptOut: false
                    isTelegramConnected: false
                    replyOnSubscribe: false
                    shouldReceiveLessNotifications: false
                    avatarHeaderConverterUpload: true
                    streamingRtmpKey: abc123
                    streamingRtmpServer: rtmp://cloudbeta.streaming.onlyfans.com/live
                    canAddPhone: true
                    phoneLast4: null
                    sendAwardsTop1: true
                    sendAwardsTop5: true
                    notifyOnAllMentions: false
                    commentsOnlyForPayers: false
                    isDrmEnabled: false
                    creatorsCommentsOnlyForFriends: false
                    muteTagsInChats: true
                    muteTagsInPosts: false
                    muteTagsInStories: true
                    muteTagsInStreams: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999983
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49986
                properties:
                  data:
                    type: object
                    properties:
                      isDeleteInitiated:
                        type: boolean
                        example: false
                      lastSubscriptionExpiredAt:
                        type: string
                        example: null
                        nullable: true
                      streamingObsKey:
                        type: string
                        example: abc123
                      streamingObsServer:
                        type: string
                        example: rtmp://route0-dc2.onlyfans.com/live
                      streamingMuxKey:
                        type: string
                        example: null
                        nullable: true
                      streamingMuxServer:
                        type: string
                        example: rtmps://global-live.mux.com:443/app
                      streamingMuxKeyExpiredAt:
                        type: string
                        example: null
                        nullable: true
                      activityHubAllowed:
                        type: boolean
                        example: false
                      activityHubTokens:
                        type: array
                        example: []
                      confirmEmailSentAt:
                        type: string
                        example: 2025-01-01T00:00:00+00:00
                      hideAfterMassMessages:
                        type: boolean
                        example: true
                      changelogUpdates:
                        type: integer
                        example: 3
                      showFullTextInEmailNotify:
                        type: boolean
                        example: false
                      isPrivate:
                        type: boolean
                        example: true
                      blockedCountries:
                        type: array
                        example: []
                      blockedStates:
                        type: array
                        example: []
                      blockedIps:
                        type: array
                        example: []
                      showPostsTips:
                        type: boolean
                        example: true
                      recommenderReward:
                        type: string
                        example: null
                        nullable: true
                      showFriendsToSubscribers:
                        type: boolean
                        example: true
                      showSubscribesOffers:
                        type: boolean
                        example: true
                      disableSubscribesOffers:
                        type: boolean
                        example: true
                      isEmailNotificationsEnabled:
                        type: boolean
                        example: false
                      canAcceptMessageOnlyFromFriends:
                        type: boolean
                        example: false
                      isAutoFollowBack:
                        type: boolean
                        example: true
                      unfollowAutoFollowBack:
                        type: boolean
                        example: false
                      changeEmailStep:
                        type: string
                        example: null
                        nullable: true
                      newEmail:
                        type: string
                        example: null
                        nullable: true
                      lifeTimeEmailCode:
                        type: string
                        example: null
                        nullable: true
                      coStreamingRequestFrom:
                        type: string
                        example: subscribers
                      hasPaidPosts:
                        type: boolean
                        example: false
                      isCoStreamingAllowed:
                        type: boolean
                        example: true
                      isMonthlyNewsletters:
                        type: boolean
                        example: false
                      strongOtp:
                        type: boolean
                        example: false
                      phoneOtp:
                        type: boolean
                        example: false
                      appOtp:
                        type: boolean
                        example: false
                      isOtpAppConnected:
                        type: boolean
                        example: false
                      isOldLoginRedirect:
                        type: boolean
                        example: true
                      faceOtp:
                        type: boolean
                        example: false
                      canSocialsConnect:
                        type: boolean
                        example: true
                      socialsConnects:
                        type: array
                        example: []
                      importantSubscriptionNotifications:
                        type: boolean
                        example: true
                      isOpenseaConnected:
                        type: boolean
                        example: false
                      forceFaceOtp:
                        type: boolean
                        example: false
                      hasPassword:
                        type: boolean
                        example: true
                      canAddSubscriberByBundle:
                        type: object
                        properties:
                          discounts:
                            type: object
                            properties:
                              "0":
                                type: string
                                example: 0% discount
                              "5":
                                type: string
                                example: 5% discount
                              "10":
                                type: string
                                example: 10% discount
                              "15":
                                type: string
                                example: 15% discount
                              "20":
                                type: string
                                example: 20% discount
                              "25":
                                type: string
                                example: 25% discount
                              "30":
                                type: string
                                example: 30% discount
                              "35":
                                type: string
                                example: 35% discount
                              "40":
                                type: string
                                example: 40% discount
                              "45":
                                type: string
                                example: 45% discount
                              "50":
                                type: string
                                example: 50% discount
                          durations:
                            type: object
                            properties:
                              "3":
                                type: string
                                example: 3 months
                              "6":
                                type: string
                                example: 6 months
                              "12":
                                type: string
                                example: 12 months
                      bundleMaxPrice:
                        type: integer
                        example: 250
                      canMakeProfileLinks:
                        type: boolean
                        example: true
                      isSuggestionsOptOut:
                        type: boolean
                        example: false
                      isTelegramConnected:
                        type: boolean
                        example: false
                      replyOnSubscribe:
                        type: boolean
                        example: false
                      shouldReceiveLessNotifications:
                        type: boolean
                        example: false
                      avatarHeaderConverterUpload:
                        type: boolean
                        example: true
                      streamingRtmpKey:
                        type: string
                        example: abc123
                      streamingRtmpServer:
                        type: string
                        example: rtmp://cloudbeta.streaming.onlyfans.com/live
                      canAddPhone:
                        type: boolean
                        example: true
                      phoneLast4:
                        type: string
                        example: null
                        nullable: true
                      sendAwardsTop1:
                        type: boolean
                        example: true
                      sendAwardsTop5:
                        type: boolean
                        example: true
                      notifyOnAllMentions:
                        type: boolean
                        example: false
                      commentsOnlyForPayers:
                        type: boolean
                        example: false
                      isDrmEnabled:
                        type: boolean
                        example: false
                      creatorsCommentsOnlyForFriends:
                        type: boolean
                        example: false
                      muteTagsInChats:
                        type: boolean
                        example: true
                      muteTagsInPosts:
                        type: boolean
                        example: false
                      muteTagsInStories:
                        type: boolean
                        example: true
                      muteTagsInStreams:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999983
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49986
      tags:
        - Settings
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Welcome Message (/api-reference/settings/get-welcome-message)

Get the current automatic welcome message template that is sent when someone subscribes.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/settings/welcome-message
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/settings/welcome-message:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Welcome Message
      operationId: getWelcomeMessage
      description: Get the current automatic welcome message template that is sent
        when someone subscribes.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: "12345678901"
                    template: reply_on_subscribe
                    text: <p>Hey, welcome to my profile</p>
                    displayText: <p>Hey, welcome to my profile</p>
                    price: 0
                    lockedText: false
                    previews: []
                    isMediaReady: true
                    mediaCount: 1
                    media:
                      - id: 1234567890
                        type: photo
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: 2026-04-28T20:44:55+00:00
                        isReady: true
                        files:
                          full:
                            url: https://cdn2.onlyfans.com/files/example/full.jpg
                            width: 549
                            height: 309
                            size: 0
                            sources: []
                          thumb:
                            url: https://cdn2.onlyfans.com/files/example/thumb.jpg
                            width: 300
                            height: 300
                            size: 0
                          preview:
                            url: https://cdn2.onlyfans.com/files/example/preview.jpg
                            width: 549
                            height: 309
                            size: 0
                          squarePreview:
                            url: https://cdn2.onlyfans.com/files/example/square.jpg
                            width: 960
                            height: 960
                            size: 0
                        duration: 0
                        releaseForms: []
                        hasCustomPreview: false
                        videoSources:
                          "240": null
                          "720": null
                    createdAt: 2026-04-28T20:44:55+00:00
                    isActive: false
                    giphyId: null
                    isCouplePeopleMedia: false
                    isMarkdownDisabled: true
                    releaseForms: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999968
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999997
                      remaining_day: 49969
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: "12345678901"
                      template:
                        type: string
                        example: reply_on_subscribe
                      text:
                        type: string
                        example: <p>Hey, welcome to my profile</p>
                      displayText:
                        type: string
                        example: <p>Hey, welcome to my profile</p>
                      price:
                        type: integer
                        example: 0
                      lockedText:
                        type: boolean
                        example: false
                      previews:
                        type: array
                        example: []
                      isMediaReady:
                        type: boolean
                        example: true
                      mediaCount:
                        type: integer
                        example: 1
                      media:
                        type: array
                        example:
                          - id: 1234567890
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: 2026-04-28T20:44:55+00:00
                            isReady: true
                            files:
                              full:
                                url: https://cdn2.onlyfans.com/files/example/full.jpg
                                width: 549
                                height: 309
                                size: 0
                                sources: []
                              thumb:
                                url: https://cdn2.onlyfans.com/files/example/thumb.jpg
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: https://cdn2.onlyfans.com/files/example/preview.jpg
                                width: 549
                                height: 309
                                size: 0
                              squarePreview:
                                url: https://cdn2.onlyfans.com/files/example/square.jpg
                                width: 960
                                height: 960
                                size: 0
                            duration: 0
                            releaseForms: []
                            hasCustomPreview: false
                            videoSources:
                              "240": null
                              "720": null
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1234567890
                            type:
                              type: string
                              example: photo
                            convertedToVideo:
                              type: boolean
                              example: false
                            canView:
                              type: boolean
                              example: true
                            hasError:
                              type: boolean
                              example: false
                            createdAt:
                              type: string
                              example: 2026-04-28T20:44:55+00:00
                            isReady:
                              type: boolean
                              example: true
                            files:
                              type: object
                              properties:
                                full:
                                  type: object
                                  properties:
                                    url:
                                      type: string
                                      example: https://cdn2.onlyfans.com/files/example/full.jpg
                                    width:
                                      type: integer
                                      example: 549
                                    height:
                                      type: integer
                                      example: 309
                                    size:
                                      type: integer
                                      example: 0
                                    sources:
                                      type: array
                                      example: []
                                thumb:
                                  type: object
                                  properties:
                                    url:
                                      type: string
                                      example: https://cdn2.onlyfans.com/files/example/thumb.jpg
                                    width:
                                      type: integer
                                      example: 300
                                    height:
                                      type: integer
                                      example: 300
                                    size:
                                      type: integer
                                      example: 0
                                preview:
                                  type: object
                                  properties:
                                    url:
                                      type: string
                                      example: https://cdn2.onlyfans.com/files/example/preview.jpg
                                    width:
                                      type: integer
                                      example: 549
                                    height:
                                      type: integer
                                      example: 309
                                    size:
                                      type: integer
                                      example: 0
                                squarePreview:
                                  type: object
                                  properties:
                                    url:
                                      type: string
                                      example: https://cdn2.onlyfans.com/files/example/square.jpg
                                    width:
                                      type: integer
                                      example: 960
                                    height:
                                      type: integer
                                      example: 960
                                    size:
                                      type: integer
                                      example: 0
                            duration:
                              type: integer
                              example: 0
                            releaseForms:
                              type: array
                              example: []
                            hasCustomPreview:
                              type: boolean
                              example: false
                            videoSources:
                              type: object
                              properties:
                                "240":
                                  type: string
                                  example: null
                                  nullable: true
                                "720":
                                  type: string
                                  example: null
                                  nullable: true
                      createdAt:
                        type: string
                        example: 2026-04-28T20:44:55+00:00
                      isActive:
                        type: boolean
                        example: false
                      giphyId:
                        type: string
                        example: null
                        nullable: true
                      isCouplePeopleMedia:
                        type: boolean
                        example: false
                      isMarkdownDisabled:
                        type: boolean
                        example: true
                      releaseForms:
                        type: array
                        example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999968
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999997
                          remaining_day:
                            type: integer
                            example: 49969
      tags:
        - Settings
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Social Media Buttons (/api-reference/settings/list-social-media-buttons)

Returns the list of social media buttons for the account

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/settings/social-media-buttons
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/settings/social-media-buttons:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Social Media Buttons
      operationId: listSocialMediaButtons
      description: Returns the list of social media buttons for the account
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - id: 123
                      sort: 0
                      label: Amazon
                      username: ""
                      socialMedia: amazon
                      link: https://amazon.com/example
                      url: https://amazon.com/example
                      isValid: true
                      clicks: 0
                    - id: 1234
                      sort: 0
                      label: Instagram
                      username: example_user
                      socialMedia: instagram
                      link: ""
                      url: https://instagram.com/example_user
                      isValid: true
                      clicks: 0
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999969
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49996
                properties:
                  data:
                    type: array
                    example:
                      - id: 123
                        sort: 0
                        label: Amazon
                        username: ""
                        socialMedia: amazon
                        link: https://amazon.com/example
                        url: https://amazon.com/example
                        isValid: true
                        clicks: 0
                      - id: 1234
                        sort: 0
                        label: Instagram
                        username: example_user
                        socialMedia: instagram
                        link: ""
                        url: https://instagram.com/example_user
                        isValid: true
                        clicks: 0
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 123
                        sort:
                          type: integer
                          example: 0
                        label:
                          type: string
                          example: Amazon
                        username:
                          type: string
                          example: ""
                        socialMedia:
                          type: string
                          example: amazon
                        link:
                          type: string
                          example: https://amazon.com/example
                        url:
                          type: string
                          example: https://amazon.com/example
                        isValid:
                          type: boolean
                          example: true
                        clicks:
                          type: integer
                          example: 0
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999969
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49996
      tags:
        - Settings
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Reorder Social Media Buttons (/api-reference/settings/reorder-social-media-buttons)

Changes the order of social media buttons for the account

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/settings/social-media-buttons/reorder
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/settings/social-media-buttons/reorder:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Reorder Social Media Buttons
      operationId: reorderSocialMediaButtons
      description: Changes the order of social media buttons for the account
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - id: 123
                      sort: 0
                      label: Amazon
                      username: ""
                      socialMedia: amazon
                      link: https://amazon.com/example
                      url: https://amazon.com/example
                      isValid: true
                      clicks: 0
                    - id: 1234
                      sort: 0
                      label: Instagram
                      username: example_user
                      socialMedia: instagram
                      link: ""
                      url: https://instagram.com/example_user
                      isValid: true
                      clicks: 0
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999969
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49996
                properties:
                  data:
                    type: array
                    example:
                      - id: 123
                        sort: 0
                        label: Amazon
                        username: ""
                        socialMedia: amazon
                        link: https://amazon.com/example
                        url: https://amazon.com/example
                        isValid: true
                        clicks: 0
                      - id: 1234
                        sort: 0
                        label: Instagram
                        username: example_user
                        socialMedia: instagram
                        link: ""
                        url: https://instagram.com/example_user
                        isValid: true
                        clicks: 0
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 123
                        sort:
                          type: integer
                          example: 0
                        label:
                          type: string
                          example: Amazon
                        username:
                          type: string
                          example: ""
                        socialMedia:
                          type: string
                          example: amazon
                        link:
                          type: string
                          example: https://amazon.com/example
                        url:
                          type: string
                          example: https://amazon.com/example
                        isValid:
                          type: boolean
                          example: true
                        clicks:
                          type: integer
                          example: 0
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999969
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49996
      tags:
        - Settings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                button_ids:
                  type: array
                  description: The new order of the buttons
                  example:
                    - 123
                    - 456
                  items:
                    type: string
              required:
                - button_ids
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Update Blocked Countries (/api-reference/settings/update-blocked-countries)

Updates the countries blocked from viewing the account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml put /api/{account}/settings/blocked-countries
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/settings/blocked-countries:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    put:
      summary: Update Blocked Countries
      operationId: updateBlockedCountries
      description: Updates the countries blocked from viewing the account.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999969
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999998
                      remaining_day: 49970
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999969
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999998
                          remaining_day:
                            type: integer
                            example: 49970
      tags:
        - Settings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                blockedCountries:
                  type: array
                  description: List of all ISO 3166-1 alpha-2 country codes to block including
                    existing ones. If you want to unblock all countries, set
                    this to an empty array or `null`.
                  example:
                    - RU
                  items:
                    type: string
                blockedStates:
                  type: array
                  description: Blocked states payload forwarded to OnlyFans. Defaults to an empty
                    array.
                  example: []
                  items:
                    type: string
              required:
                - blockedCountries
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Update Profile (/api-reference/settings/update-profile)

Updates the account profile. **Only include the fields you want to update.** To make a field empty, set it to `null`.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/settings/profile
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/settings/profile:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Update Profile
      operationId: updateProfile
      description: Updates the account profile. **Only include the fields you want to
        update.** To make a field empty, set it to `null`.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999969
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999998
                      remaining_day: 49970
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999969
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999998
                          remaining_day:
                            type: integer
                            example: 49970
      tags:
        - Settings
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                username:
                  type: string
                  description: The new username to use. Make sure to first check if it exists
                    using our `/settings/username-exists` endpoint.
                  example: MyNewUsername
                name:
                  type: string
                  description: The new display name to use. Set to `null` to use the default
                    display name.
                  example: u1234
                  nullable: true
                avatar:
                  type: string
                  description: The new avatar to use. Must be a `ofapi_media_` ID. Refer to our
                    `/media/upload` endpoint on how to get this.
                  example: ofapi_media_abc123
                header:
                  type: string
                  description: The new header (banner) to use. Must be a `ofapi_media_` ID. Refer
                    to our `/media/upload` endpoint on how to get this.
                  example: ofapi_media_abc123
                about:
                  type: string
                  description: The new bio to use. Set to `null` to empty it.
                  example: Hey there!
                  nullable: true
                location:
                  type: string
                  description: The new location to use. Set to `null` to empty it.
                  example: Europe
                  nullable: true
                website:
                  type: string
                  description: The new website URL to use. Must be a valid URL. Set to `null` to
                    empty it.
                  example: https://example.com
                  nullable: true
                wishlist:
                  type: string
                  description: The new Amazon Wishlist URL to use. Must be a valid URL. Set to
                    `null` to empty it.
                  example: https://example.com
                  nullable: true
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Update Social Media Button (/api-reference/settings/update-social-media-button)

Updates a social media button from the account

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml put /api/{account}/settings/social-media-buttons/{button_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/settings/social-media-buttons/{button_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: button_id
        description: The ID of the social media button to update
        example: 123
        required: true
        schema:
          type: string
    put:
      summary: Update Social Media Button
      operationId: updateSocialMediaButton
      description: Updates a social media button from the account
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - id: 3384764
                      sort: 0
                      label: new
                      username: test
                      socialMedia: instagram
                      link: ""
                      url: https://instagram.com/test
                      isValid: true
                      clicks: 0
                    - id: 3385711
                      sort: 1
                      label: X
                      username: test
                      socialMedia: x
                      link: ""
                      url: https://twitter.com/test
                      isValid: true
                      clicks: 0
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999905
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 995
                      remaining_day: 49993
                properties:
                  data:
                    type: array
                    example:
                      - id: 3384764
                        sort: 0
                        label: new
                        username: test
                        socialMedia: instagram
                        link: ""
                        url: https://instagram.com/test
                        isValid: true
                        clicks: 0
                      - id: 3385711
                        sort: 1
                        label: X
                        username: test
                        socialMedia: x
                        link: ""
                        url: https://twitter.com/test
                        isValid: true
                        clicks: 0
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 3384764
                        sort:
                          type: integer
                          example: 0
                        label:
                          type: string
                          example: new
                        username:
                          type: string
                          example: test
                        socialMedia:
                          type: string
                          example: instagram
                        link:
                          type: string
                          example: ""
                        url:
                          type: string
                          example: https://instagram.com/test
                        isValid:
                          type: boolean
                          example: true
                        clicks:
                          type: integer
                          example: 0
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999905
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 995
                          remaining_day:
                            type: integer
                            example: 49993
      tags:
        - Settings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                label:
                  type: string
                  description: The new label for the button
                  example: Instagram
              required:
                - label
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Update Subscription Price (/api-reference/settings/update-subscription-price)

Update the account subscription price. Send `0` or `"free"` to make the account free. ⚠️ WARNING! OnlyFans limits updating the subscription price to max. 3 times per day.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml patch /api/{account}/settings/subscription-price
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/settings/subscription-price:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    patch:
      summary: Update Subscription Price
      operationId: updateSubscriptionPrice
      description: 'Update the account subscription price. Send `0` or `"free"` to
        make the account free. ⚠️ WARNING! OnlyFans limits updating the
        subscription price to max. 3 times per day. '
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999969
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999998
                      remaining_day: 49970
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999969
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999998
                          remaining_day:
                            type: integer
                            example: 49970
      tags:
        - Settings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                price:
                  type: string
                  description: The new subscription price. Accepts `0`, `"free"`, or a number
                    between 4.99 and 200.
                  example: "4.99"
              required:
                - price
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Update Welcome Message (/api-reference/settings/update-welcome-message)

Update the automatic welcome message template that is sent when someone subscribes.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/settings/welcome-message
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/settings/welcome-message:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Update Welcome Message
      operationId: updateWelcomeMessage
      description: Update the automatic welcome message template that is sent when
        someone subscribes.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: "12345678901"
                    template: reply_on_subscribe
                    text: <p>Hey, welcome to my profile</p>
                    displayText: <p>Hey, welcome to my profile</p>
                    price: 0
                    lockedText: false
                    previews: []
                    isMediaReady: true
                    mediaCount: 1
                    media:
                      - id: 1234567890
                        type: photo
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: 2026-04-28T20:44:55+00:00
                        isReady: true
                        files:
                          full:
                            url: https://cdn2.onlyfans.com/files/example/full.jpg
                            width: 549
                            height: 309
                            size: 0
                            sources: []
                          thumb:
                            url: https://cdn2.onlyfans.com/files/example/thumb.jpg
                            width: 300
                            height: 300
                            size: 0
                          preview:
                            url: https://cdn2.onlyfans.com/files/example/preview.jpg
                            width: 549
                            height: 309
                            size: 0
                          squarePreview:
                            url: https://cdn2.onlyfans.com/files/example/square.jpg
                            width: 960
                            height: 960
                            size: 0
                        duration: 0
                        releaseForms: []
                        hasCustomPreview: false
                        videoSources:
                          "240": null
                          "720": null
                    createdAt: 2026-04-28T20:44:55+00:00
                    isActive: false
                    giphyId: null
                    isCouplePeopleMedia: false
                    isMarkdownDisabled: true
                    releaseForms: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999968
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999997
                      remaining_day: 49969
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: "12345678901"
                      template:
                        type: string
                        example: reply_on_subscribe
                      text:
                        type: string
                        example: <p>Hey, welcome to my profile</p>
                      displayText:
                        type: string
                        example: <p>Hey, welcome to my profile</p>
                      price:
                        type: integer
                        example: 0
                      lockedText:
                        type: boolean
                        example: false
                      previews:
                        type: array
                        example: []
                      isMediaReady:
                        type: boolean
                        example: true
                      mediaCount:
                        type: integer
                        example: 1
                      media:
                        type: array
                        example:
                          - id: 1234567890
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: 2026-04-28T20:44:55+00:00
                            isReady: true
                            files:
                              full:
                                url: https://cdn2.onlyfans.com/files/example/full.jpg
                                width: 549
                                height: 309
                                size: 0
                                sources: []
                              thumb:
                                url: https://cdn2.onlyfans.com/files/example/thumb.jpg
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: https://cdn2.onlyfans.com/files/example/preview.jpg
                                width: 549
                                height: 309
                                size: 0
                              squarePreview:
                                url: https://cdn2.onlyfans.com/files/example/square.jpg
                                width: 960
                                height: 960
                                size: 0
                            duration: 0
                            releaseForms: []
                            hasCustomPreview: false
                            videoSources:
                              "240": null
                              "720": null
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1234567890
                            type:
                              type: string
                              example: photo
                            convertedToVideo:
                              type: boolean
                              example: false
                            canView:
                              type: boolean
                              example: true
                            hasError:
                              type: boolean
                              example: false
                            createdAt:
                              type: string
                              example: 2026-04-28T20:44:55+00:00
                            isReady:
                              type: boolean
                              example: true
                            files:
                              type: object
                              properties:
                                full:
                                  type: object
                                  properties:
                                    url:
                                      type: string
                                      example: https://cdn2.onlyfans.com/files/example/full.jpg
                                    width:
                                      type: integer
                                      example: 549
                                    height:
                                      type: integer
                                      example: 309
                                    size:
                                      type: integer
                                      example: 0
                                    sources:
                                      type: array
                                      example: []
                                thumb:
                                  type: object
                                  properties:
                                    url:
                                      type: string
                                      example: https://cdn2.onlyfans.com/files/example/thumb.jpg
                                    width:
                                      type: integer
                                      example: 300
                                    height:
                                      type: integer
                                      example: 300
                                    size:
                                      type: integer
                                      example: 0
                                preview:
                                  type: object
                                  properties:
                                    url:
                                      type: string
                                      example: https://cdn2.onlyfans.com/files/example/preview.jpg
                                    width:
                                      type: integer
                                      example: 549
                                    height:
                                      type: integer
                                      example: 309
                                    size:
                                      type: integer
                                      example: 0
                                squarePreview:
                                  type: object
                                  properties:
                                    url:
                                      type: string
                                      example: https://cdn2.onlyfans.com/files/example/square.jpg
                                    width:
                                      type: integer
                                      example: 960
                                    height:
                                      type: integer
                                      example: 960
                                    size:
                                      type: integer
                                      example: 0
                            duration:
                              type: integer
                              example: 0
                            releaseForms:
                              type: array
                              example: []
                            hasCustomPreview:
                              type: boolean
                              example: false
                            videoSources:
                              type: object
                              properties:
                                "240":
                                  type: string
                                  example: null
                                  nullable: true
                                "720":
                                  type: string
                                  example: null
                                  nullable: true
                      createdAt:
                        type: string
                        example: 2026-04-28T20:44:55+00:00
                      isActive:
                        type: boolean
                        example: false
                      giphyId:
                        type: string
                        example: null
                        nullable: true
                      isCouplePeopleMedia:
                        type: boolean
                        example: false
                      isMarkdownDisabled:
                        type: boolean
                        example: true
                      releaseForms:
                        type: array
                        example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999968
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999997
                          remaining_day:
                            type: integer
                            example: 49969
      tags:
        - Settings
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: The welcome message text content. Required unless a media file is
                    present.
                  example: <p>Hey, welcome to my profile</p>
                lockedText:
                  type: boolean
                  description: Whether the text should be shown or hidden.
                  example: false
                price:
                  type: integer
                  description: Price for paid content (0 or between 3-200). In case this is not
                    zero, **mediaFiles** is required.
                  example: 0
                mediaFiles:
                  type: array
                  description: Direct file uploads, OFAPI `ofapi_media_` IDs, or OF vault IDs.
                    Will be hidden if `price` is provided.
                  example:
                    - ofapi_media_abc123
                    - 1234567890
                  items:
                    type: file[]|string
                previews:
                  type: array
                  description: Direct file uploads, OFAPI `ofapi_media_` IDs, OF vault IDs, or
                    integer indices referencing uploaded files in `mediaFiles`.
                    Will be shown if `price` is provided.
                  example:
                    - ofapi_media_abc123
                    - 1234567890
                  items:
                    type: file[]|string[]|int
                rfTag:
                  type: string
                  description: Array of OnlyFans Creator User IDs to tag in your message.
                  example: null
                rfGuest:
                  type: string
                  description: Array of OnlyFans Release Form Guest IDs to tag in your message.
                  example: null
                rfPartner:
                  type: string
                  description: Array of OnlyFans Release Form Partners IDs to tag in your message.
                  example: null
                isForward:
                  type: boolean
                  description: ""
                  example: false
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Create Smart Link Postback (/api-reference/smart-link-postbacks/create-smart-link-postback)

Create a postback that fires for selected Smart Link conversion types

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/smart-link-postbacks
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/smart-link-postbacks:
    post:
      summary: Create Smart Link Postback
      operationId: createSmartLinkPostback
      description: Create a postback that fires for selected Smart Link conversion types
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    url: https://example.com/postback?click={click_id}&type={conversion_type}&gclid={gclid}
                    http_method: POST
                    body: '{"click_id":"{click_id}","value":"{amount_gross}"}'
                    headers:
                      - name: Authorization
                        value: Bearer token
                    smart_link_scope: global
                    conversion_types:
                      - new_subscriber
                      - new_transaction
                    smart_link_ids: []
                    smart_links: []
                    latest_response: null
                    created_at: 2026-01-31T21:45:00+00:00
                    updated_at: 2026-01-31T21:45:00+00:00
                  _meta:
                    _credits:
                      used: 0
                      balance: 999999
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      url:
                        type: string
                        example: https://example.com/postback?click={click_id}&type={conversion_type}&gclid={gclid}
                      http_method:
                        type: string
                        example: POST
                      body:
                        type: string
                        example: '{"click_id":"{click_id}","value":"{amount_gross}"}'
                      headers:
                        type: array
                        example:
                          - name: Authorization
                            value: Bearer token
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                              example: Authorization
                            value:
                              type: string
                              example: Bearer token
                      smart_link_scope:
                        type: string
                        example: global
                      conversion_types:
                        type: array
                        example:
                          - new_subscriber
                          - new_transaction
                        items:
                          type: string
                      smart_link_ids:
                        type: array
                        example: []
                      smart_links:
                        type: array
                        example: []
                      latest_response:
                        type: string
                        example: null
                        nullable: true
                      created_at:
                        type: string
                        example: 2026-01-31T21:45:00+00:00
                      updated_at:
                        type: string
                        example: 2026-01-31T21:45:00+00:00
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 999999
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
      tags:
        - Smart Link Postbacks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: The destination URL. Variables such as `{external_click_id}`,
                    `{fbclid}`, `{gclid}`, and `{ttclid}` are replaced when the
                    postback is dispatched.
                  example: https://example.com/postback?click={external_click_id}&type={conversion_type}&gclid={gclid}
                http_method:
                  type: string
                  description: HTTP method used for the postback request. Defaults to `GET` when
                    omitted.
                  example: POST
                  enum:
                    - GET
                    - POST
                body:
                  type: string
                  description: Optional request body template for POST postbacks. Variables are
                    replaced when the postback is dispatched.
                  example: '{"click_id":"{click_id}","value":"{amount_gross}"}'
                headers:
                  type: array
                  description: Optional request headers. Header values may include postback
                    variables.
                  example:
                    - name: Authorization
                      value: Bearer token
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                        description: This field is required when <code>headers.*.value</code> is
                          present. Must match the regex
                          /\A[A-Za-z0-9!#$%&'*+.^_`|~-]+\z/. Must not be greater
                          than 100 characters.
                        example: nnmrpcidgkgntkig
                        nullable: true
                      value:
                        type: string
                        description: Must not be greater than 2000 characters.
                        example: wdfkiz
                        nullable: true
                smart_link_scope:
                  type: string
                  description: "`global` fires for all Smart Links. `campaign_specific` fires only
                    for selected Smart Links."
                  example: campaign_specific
                  enum:
                    - global
                    - campaign_specific
                conversion_types:
                  type: array
                  description: One or more Smart Link conversion types that should trigger this
                    postback.
                  example:
                    - new_subscriber
                    - new_transaction
                  items:
                    type: string
                smart_link_ids:
                  type: array
                  description: Smart Link ULIDs. Required when `smart_link_scope` is
                    `campaign_specific`.
                  example:
                    - 01JTESTLINK000000000000001
                  items:
                    type: string
              required:
                - url
                - smart_link_scope
                - conversion_types
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Delete Smart Link Postback (/api-reference/smart-link-postbacks/delete-smart-link-postback)

Delete a Smart Link postback

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/smart-link-postbacks/{postback_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/smart-link-postbacks/{postback_id}:
    parameters:
      - in: path
        name: postback_id
        description: The postback ID
        example: 123
        required: true
        schema:
          type: integer
    delete:
      summary: Delete Smart Link Postback
      operationId: deleteSmartLinkPostback
      description: Delete a Smart Link postback
      parameters: []
      responses:
        "204":
          description: Successfully deleted
          content:
            application/json:
              schema:
                type: object
                nullable: true
      tags:
        - Smart Link Postbacks
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Smart Link Postbacks (/api-reference/smart-link-postbacks/list-smart-link-postbacks)

List all Smart Link postbacks configured for your Team

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/smart-link-postbacks
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/smart-link-postbacks:
    get:
      summary: List Smart Link Postbacks
      operationId: listSmartLinkPostbacks
      description: List all Smart Link postbacks configured for your Team
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - id: 123
                      url: https://example.com/postback?click={click_id}&type={conversion_type}&gclid={gclid}
                      http_method: POST
                      body: '{"click_id":"{click_id}","value":"{amount_gross}"}'
                      headers:
                        - name: Authorization
                          value: Bearer token
                      smart_link_scope: campaign_specific
                      conversion_types:
                        - new_subscriber
                        - new_transaction
                      smart_link_ids:
                        - 01JTESTLINK000000000000001
                      smart_links:
                        - link_ulid: 01JTESTLINK000000000000001
                          name: Instagram Bio Link
                          account_display_name: Creator Main
                          account_prefixed_id: acct_XXXXXXXX
                      latest_response:
                        id: 456
                        conversion_type: new_subscriber
                        postback_url: https://example.com/postback?click=01JTESTCLICK000000000000001&type=new_subscriber&gclid=google-click-id
                        succeeded: true
                        status_code: 200
                        error_type: null
                        error_message: null
                        created_at: 2026-01-31T22:16:00+00:00
                      created_at: 2026-01-31T21:45:00+00:00
                      updated_at: 2026-01-31T21:45:00+00:00
                  _meta:
                    _credits:
                      used: 0
                      balance: 999999
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                properties:
                  data:
                    type: array
                    example:
                      - id: 123
                        url: https://example.com/postback?click={click_id}&type={conversion_type}&gclid={gclid}
                        http_method: POST
                        body: '{"click_id":"{click_id}","value":"{amount_gross}"}'
                        headers:
                          - name: Authorization
                            value: Bearer token
                        smart_link_scope: campaign_specific
                        conversion_types:
                          - new_subscriber
                          - new_transaction
                        smart_link_ids:
                          - 01JTESTLINK000000000000001
                        smart_links:
                          - link_ulid: 01JTESTLINK000000000000001
                            name: Instagram Bio Link
                            account_display_name: Creator Main
                            account_prefixed_id: acct_XXXXXXXX
                        latest_response:
                          id: 456
                          conversion_type: new_subscriber
                          postback_url: https://example.com/postback?click=01JTESTCLICK000000000000001&type=new_subscriber&gclid=google-click-id
                          succeeded: true
                          status_code: 200
                          error_type: null
                          error_message: null
                          created_at: 2026-01-31T22:16:00+00:00
                        created_at: 2026-01-31T21:45:00+00:00
                        updated_at: 2026-01-31T21:45:00+00:00
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 123
                        url:
                          type: string
                          example: https://example.com/postback?click={click_id}&type={conversion_type}&gclid={gclid}
                        http_method:
                          type: string
                          example: POST
                        body:
                          type: string
                          example: '{"click_id":"{click_id}","value":"{amount_gross}"}'
                        headers:
                          type: array
                          example:
                            - name: Authorization
                              value: Bearer token
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                                example: Authorization
                              value:
                                type: string
                                example: Bearer token
                        smart_link_scope:
                          type: string
                          example: campaign_specific
                        conversion_types:
                          type: array
                          example:
                            - new_subscriber
                            - new_transaction
                          items:
                            type: string
                        smart_link_ids:
                          type: array
                          example:
                            - 01JTESTLINK000000000000001
                          items:
                            type: string
                        smart_links:
                          type: array
                          example:
                            - link_ulid: 01JTESTLINK000000000000001
                              name: Instagram Bio Link
                              account_display_name: Creator Main
                              account_prefixed_id: acct_XXXXXXXX
                          items:
                            type: object
                            properties:
                              link_ulid:
                                type: string
                                example: 01JTESTLINK000000000000001
                              name:
                                type: string
                                example: Instagram Bio Link
                              account_display_name:
                                type: string
                                example: Creator Main
                              account_prefixed_id:
                                type: string
                                example: acct_XXXXXXXX
                        latest_response:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 456
                            conversion_type:
                              type: string
                              example: new_subscriber
                            postback_url:
                              type: string
                              example: https://example.com/postback?click=01JTESTCLICK000000000000001&type=new_subscriber&gclid=google-click-id
                            succeeded:
                              type: boolean
                              example: true
                            status_code:
                              type: integer
                              example: 200
                            error_type:
                              type: string
                              example: null
                              nullable: true
                            error_message:
                              type: string
                              example: null
                              nullable: true
                            created_at:
                              type: string
                              example: 2026-01-31T22:16:00+00:00
                        created_at:
                          type: string
                          example: 2026-01-31T21:45:00+00:00
                        updated_at:
                          type: string
                          example: 2026-01-31T21:45:00+00:00
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 999999
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
      tags:
        - Smart Link Postbacks
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Show Smart Link Postback (/api-reference/smart-link-postbacks/show-smart-link-postback)

Retrieve a Smart Link postback by ID

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/smart-link-postbacks/{postback_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/smart-link-postbacks/{postback_id}:
    parameters:
      - in: path
        name: postback_id
        description: The postback ID
        example: 123
        required: true
        schema:
          type: integer
    get:
      summary: Show Smart Link Postback
      operationId: showSmartLinkPostback
      description: Retrieve a Smart Link postback by ID
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    url: https://example.com/postback?click={click_id}&type={conversion_type}&gclid={gclid}
                    http_method: POST
                    body: '{"click_id":"{click_id}","value":"{amount_gross}"}'
                    headers:
                      - name: Authorization
                        value: Bearer token
                    smart_link_scope: campaign_specific
                    conversion_types:
                      - new_subscriber
                      - new_transaction
                    smart_link_ids:
                      - 01JTESTLINK000000000000001
                    smart_links:
                      - link_ulid: 01JTESTLINK000000000000001
                        name: Instagram Bio Link
                        account_display_name: Creator Main
                        account_prefixed_id: acct_XXXXXXXX
                    latest_response: null
                    created_at: 2026-01-31T21:45:00+00:00
                    updated_at: 2026-01-31T21:45:00+00:00
                  _meta:
                    _credits:
                      used: 0
                      balance: 999999
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      url:
                        type: string
                        example: https://example.com/postback?click={click_id}&type={conversion_type}&gclid={gclid}
                      http_method:
                        type: string
                        example: POST
                      body:
                        type: string
                        example: '{"click_id":"{click_id}","value":"{amount_gross}"}'
                      headers:
                        type: array
                        example:
                          - name: Authorization
                            value: Bearer token
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                              example: Authorization
                            value:
                              type: string
                              example: Bearer token
                      smart_link_scope:
                        type: string
                        example: campaign_specific
                      conversion_types:
                        type: array
                        example:
                          - new_subscriber
                          - new_transaction
                        items:
                          type: string
                      smart_link_ids:
                        type: array
                        example:
                          - 01JTESTLINK000000000000001
                        items:
                          type: string
                      smart_links:
                        type: array
                        example:
                          - link_ulid: 01JTESTLINK000000000000001
                            name: Instagram Bio Link
                            account_display_name: Creator Main
                            account_prefixed_id: acct_XXXXXXXX
                        items:
                          type: object
                          properties:
                            link_ulid:
                              type: string
                              example: 01JTESTLINK000000000000001
                            name:
                              type: string
                              example: Instagram Bio Link
                            account_display_name:
                              type: string
                              example: Creator Main
                            account_prefixed_id:
                              type: string
                              example: acct_XXXXXXXX
                      latest_response:
                        type: string
                        example: null
                        nullable: true
                      created_at:
                        type: string
                        example: 2026-01-31T21:45:00+00:00
                      updated_at:
                        type: string
                        example: 2026-01-31T21:45:00+00:00
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 999999
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
      tags:
        - Smart Link Postbacks
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Update Smart Link Postback (/api-reference/smart-link-postbacks/update-smart-link-postback)

Update a Smart Link postback configuration

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml patch /api/smart-link-postbacks/{postback_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/smart-link-postbacks/{postback_id}:
    parameters:
      - in: path
        name: postback_id
        description: The postback ID
        example: 123
        required: true
        schema:
          type: integer
    patch:
      summary: Update Smart Link Postback
      operationId: updateSmartLinkPostback
      description: Update a Smart Link postback configuration
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    url: https://example.com/updated?click={click_id}&type={conversion_type}&ttclid={ttclid}
                    http_method: POST
                    body: '{"click_id":"{click_id}","value":"{amount_gross}"}'
                    headers:
                      - name: Authorization
                        value: Bearer token
                    smart_link_scope: campaign_specific
                    conversion_types:
                      - new_subscriber
                    smart_link_ids:
                      - 01JTESTLINK000000000000001
                    smart_links:
                      - link_ulid: 01JTESTLINK000000000000001
                        name: Instagram Bio Link
                        account_display_name: Creator Main
                        account_prefixed_id: acct_XXXXXXXX
                    latest_response: null
                    created_at: 2026-01-31T21:45:00+00:00
                    updated_at: 2026-01-31T22:00:00+00:00
                  _meta:
                    _credits:
                      used: 0
                      balance: 999999
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      url:
                        type: string
                        example: https://example.com/updated?click={click_id}&type={conversion_type}&ttclid={ttclid}
                      http_method:
                        type: string
                        example: POST
                      body:
                        type: string
                        example: '{"click_id":"{click_id}","value":"{amount_gross}"}'
                      headers:
                        type: array
                        example:
                          - name: Authorization
                            value: Bearer token
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                              example: Authorization
                            value:
                              type: string
                              example: Bearer token
                      smart_link_scope:
                        type: string
                        example: campaign_specific
                      conversion_types:
                        type: array
                        example:
                          - new_subscriber
                        items:
                          type: string
                      smart_link_ids:
                        type: array
                        example:
                          - 01JTESTLINK000000000000001
                        items:
                          type: string
                      smart_links:
                        type: array
                        example:
                          - link_ulid: 01JTESTLINK000000000000001
                            name: Instagram Bio Link
                            account_display_name: Creator Main
                            account_prefixed_id: acct_XXXXXXXX
                        items:
                          type: object
                          properties:
                            link_ulid:
                              type: string
                              example: 01JTESTLINK000000000000001
                            name:
                              type: string
                              example: Instagram Bio Link
                            account_display_name:
                              type: string
                              example: Creator Main
                            account_prefixed_id:
                              type: string
                              example: acct_XXXXXXXX
                      latest_response:
                        type: string
                        example: null
                        nullable: true
                      created_at:
                        type: string
                        example: 2026-01-31T21:45:00+00:00
                      updated_at:
                        type: string
                        example: 2026-01-31T22:00:00+00:00
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 999999
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
      tags:
        - Smart Link Postbacks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: The destination URL.
                  example: https://example.com/postback?click={external_click_id}&type={conversion_type}
                http_method:
                  type: string
                  description: HTTP method used for the postback request. Existing value is kept
                    when omitted.
                  example: POST
                  enum:
                    - GET
                    - POST
                body:
                  type: string
                  description: Optional request body template for POST postbacks. Variables are
                    replaced when the postback is dispatched.
                  example: '{"click_id":"{click_id}","value":"{amount_gross}"}'
                headers:
                  type: array
                  description: Optional request headers. Header values may include postback
                    variables.
                  example:
                    - name: Authorization
                      value: Bearer token
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                        description: This field is required when <code>headers.*.value</code> is
                          present. Must match the regex
                          /\A[A-Za-z0-9!#$%&'*+.^_`|~-]+\z/. Must not be greater
                          than 100 characters.
                        example: vnmm
                        nullable: true
                      value:
                        type: string
                        description: Must not be greater than 2000 characters.
                        example: qcvhturcfgdaocxamkmu
                        nullable: true
                smart_link_scope:
                  type: string
                  description: "`global` or `campaign_specific`."
                  example: global
                  enum:
                    - global
                    - campaign_specific
                conversion_types:
                  type: array
                  description: One or more Smart Link conversion types that should trigger this
                    postback.
                  example:
                    - new_subscriber
                  items:
                    type: string
                smart_link_ids:
                  type: array
                  description: Smart Link ULIDs. Required when `smart_link_scope` is
                    `campaign_specific`.
                  example:
                    - 01JTESTLINK000000000000001
                  items:
                    type: string
              required:
                - url
                - smart_link_scope
                - conversion_types
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Add Shared Tracking Link Tags (/api-reference/shared-tracking-links/add-shared-tracking-link-tags)

Add tags to a shared Tracking Link. Existing tags are preserved. Tag namespace is shared with owned Tracking Links. This is a free endpoint.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/shared-tracking-links/{shared_tracking_link_id}/tags
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/shared-tracking-links/{shared_tracking_link_id}/tags:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: shared_tracking_link_id
        description: The OnlyFans-side ID of the shared tracking link
        example: 123
        required: true
        schema:
          type: integer
    post:
      summary: Add Shared Tracking Link Tags
      operationId: addSharedTrackingLinkTags
      description: Add tags to a shared Tracking Link. Existing tags are preserved.
        Tag namespace is shared with owned Tracking Links. This is a free
        endpoint.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    tags:
                      - collab
                      - sfs
                  _meta:
                    _credits:
                      used: 0
                      balance: 10055833
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      tags:
                        type: array
                        example:
                          - collab
                          - sfs
                        items:
                          type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 10055833
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Shared Tracking Links
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tags:
                  type: array
                  description: Array of tag names to add to the shared tracking link.
                  example: '["collab", "sfs"]'
                  items:
                    type: string
              required:
                - tags
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Shared Tracking Link Tags (/api-reference/shared-tracking-links/list-shared-tracking-link-tags)

Get tags for a specific shared Tracking Link. Tag namespace is shared with owned Tracking Links. This is a free endpoint.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/shared-tracking-links/{shared_tracking_link_id}/tags
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/shared-tracking-links/{shared_tracking_link_id}/tags:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: shared_tracking_link_id
        description: The OnlyFans-side ID of the shared tracking link
        example: 123
        required: true
        schema:
          type: integer
    get:
      summary: List Shared Tracking Link Tags
      operationId: listSharedTrackingLinkTags
      description: Get tags for a specific shared Tracking Link. Tag namespace is
        shared with owned Tracking Links. This is a free endpoint.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    tags:
                      - collab
                      - sfs
                  _meta:
                    _credits:
                      used: 0
                      balance: 10055833
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      tags:
                        type: array
                        example:
                          - collab
                          - sfs
                        items:
                          type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 10055833
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Shared Tracking Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Shared Tracking Links (/api-reference/shared-tracking-links/list-shared-tracking-links)

List all Tracking Links (campaigns) shared with the account by other OF creators. Calls OnlyFans live and syncs to our cache.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/shared-tracking-links
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/shared-tracking-links:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Shared Tracking Links
      operationId: listSharedTrackingLinks
      description: List all Tracking Links (campaigns) shared with the account by
        other OF creators. Calls OnlyFans live and syncs to our cache.
      parameters:
        - in: query
          name: limit
          description: The number of shared tracking links to return. Default `10`. Must
            be at least 1. Must not be greater than 100.
          example: 10
          required: false
          schema:
            type: integer
            description: The number of shared tracking links to return. Default `10`. Must
              be at least 1. Must not be greater than 100.
            example: 10
        - in: query
          name: offset
          description: The offset used for pagination. Default `0`. Must be at least 0.
          example: 0
          required: false
          schema:
            type: integer
            description: The offset used for pagination. Default `0`. Must be at least 0.
            example: 0
        - in: query
          name: pagination
          description: Whether pagination metadata is enabled. Default `1`.
          example: 1
          required: false
          schema:
            type: integer
            description: Whether pagination metadata is enabled. Default `1`.
            example: 1
            enum:
              - 0
              - 1
        - in: query
          name: with_deleted
          description: Whether to include deleted shared tracking links. Default `1`.
          example: 1
          required: false
          schema:
            type: integer
            description: Whether to include deleted shared tracking links. Default `1`.
            example: 1
            enum:
              - 0
              - 1
        - in: query
          name: sorting_deleted
          description: Whether deleted links participate in sorting. Default `1`.
          example: 1
          required: false
          schema:
            type: integer
            description: Whether deleted links participate in sorting. Default `1`.
            example: 1
            enum:
              - 0
              - 1
        - in: query
          name: stats
          description: Whether statistics are included. Default `true`. Must not be
            greater than 10 characters.
          example: "true"
          required: false
          schema:
            type: string
            description: Whether statistics are included. Default `true`. Must not be
              greater than 10 characters.
            example: "true"
        - in: query
          name: synchronous
          description: Wait for the database sync instead of processing it in the
            background.
          example: false
          required: false
          schema:
            type: boolean
            description: Wait for the database sync instead of processing it in the
              background.
            example: false
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - id: 123
                        campaignCode: 123
                        campaignName: Example shared tracking link
                        campaignUrl: https://onlyfans.com/username/c123
                        subscribersCount: 0
                        clicksCount: 12
                        createdAt: 2025-01-01T01:01:01+00:00
                        endDate: null
                        isDeleted: false
                        tags: []
                        owner:
                          id: 123
                          username: username
                          name: Model name
                          avatarThumbUrl: https://thumbs.onlyfans.com/public/files/thumbs/a123/a/aa/aaa/abc123/123/avatar.jpg
                    hasMore: true
                  _pagination:
                    next_page: https://app.onlyfansapi.com/api/acct_abc123/shared-tracking-links?limit=10&offset=10
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055833
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - id: 123
                            campaignCode: 123
                            campaignName: Example shared tracking link
                            campaignUrl: https://onlyfans.com/username/c123
                            subscribersCount: 0
                            clicksCount: 12
                            createdAt: 2025-01-01T01:01:01+00:00
                            endDate: null
                            isDeleted: false
                            tags: []
                            owner:
                              id: 123
                              username: username
                              name: Model name
                              avatarThumbUrl: https://thumbs.onlyfans.com/public/files/thumbs/a123/a/aa/aaa/abc123/123/avatar.jpg
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            campaignCode:
                              type: integer
                              example: 123
                            campaignName:
                              type: string
                              example: Example shared tracking link
                            campaignUrl:
                              type: string
                              example: https://onlyfans.com/username/c123
                            subscribersCount:
                              type: integer
                              example: 0
                            clicksCount:
                              type: integer
                              example: 12
                            createdAt:
                              type: string
                              example: 2025-01-01T01:01:01+00:00
                            endDate:
                              type: string
                              example: null
                              nullable: true
                            isDeleted:
                              type: boolean
                              example: false
                            tags:
                              type: array
                              example: []
                            owner:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                username:
                                  type: string
                                  example: username
                                name:
                                  type: string
                                  example: Model name
                                avatarThumbUrl:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/a123/a/aa/aaa/abc123/123/avatar.jpg
                      hasMore:
                        type: boolean
                        example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: https://app.onlyfansapi.com/api/acct_abc123/shared-tracking-links?limit=10&offset=10
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055833
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Shared Tracking Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Remove Shared Tracking Link Tags (/api-reference/shared-tracking-links/remove-shared-tracking-link-tags)

Remove tags from a shared Tracking Link. Tag namespace is shared with owned Tracking Links. This is a free endpoint.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/shared-tracking-links/{shared_tracking_link_id}/tags
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/shared-tracking-links/{shared_tracking_link_id}/tags:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: shared_tracking_link_id
        description: The OnlyFans-side ID of the shared tracking link
        example: 123
        required: true
        schema:
          type: integer
    delete:
      summary: Remove Shared Tracking Link Tags
      operationId: removeSharedTrackingLinkTags
      description: Remove tags from a shared Tracking Link. Tag namespace is shared
        with owned Tracking Links. This is a free endpoint.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    tags:
                      - sfs
                  _meta:
                    _credits:
                      used: 0
                      balance: 10055833
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      tags:
                        type: array
                        example:
                          - sfs
                        items:
                          type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 10055833
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Shared Tracking Links
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tags:
                  type: array
                  description: Array of tag names to remove from the shared tracking link.
                  example: '["collab"]'
                  items:
                    type: string
              required:
                - tags
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Revoke Shared Tracking Link Access (/api-reference/shared-tracking-links/revoke-shared-tracking-link-access)

Revoke the account's access to a shared Tracking Link (campaign). Calls OnlyFans `DELETE /campaigns/share-access`, then removes the local cache row. The owner keeps the link.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/shared-tracking-links/{shared_tracking_link_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/shared-tracking-links/{shared_tracking_link_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: shared_tracking_link_id
        description: The OnlyFans-side ID of the shared tracking link
        example: 123
        required: true
        schema:
          type: integer
    delete:
      summary: Revoke Shared Tracking Link Access
      operationId: revokeSharedTrackingLinkAccess
      description: Revoke the account's access to a shared Tracking Link (campaign).
        Calls OnlyFans `DELETE /campaigns/share-access`, then removes the local
        cache row. The owner keeps the link.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055832
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055832
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Shared Tracking Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Stored Free Trial Links (/api-reference/stored-free-trial-links/list-stored-free-trial-links)

List all stored free trial links from the OnlyFansAPI Cache. This is a free endpoint that does not call the OnlyFans API.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/stored/trial-links
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/stored/trial-links:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Stored Free Trial Links
      operationId: listStoredFreeTrialLinks
      description: List all stored free trial links from the OnlyFansAPI Cache. This
        is a free endpoint that does not call the OnlyFans API.
      parameters:
        - in: query
          name: limit
          description: The number of trial links to return. Default `10`. Must be at least
            1. Must not be greater than 1000.
          example: 10
          required: false
          schema:
            type: integer
            description: The number of trial links to return. Default `10`. Must be at least
              1. Must not be greater than 1000.
            example: 10
        - in: query
          name: offset
          description: The offset used for pagination. Default `0`. Must be at least 0.
          example: 0
          required: false
          schema:
            type: integer
            description: The offset used for pagination. Default `0`. Must be at least 0.
            example: 0
        - in: query
          name: filter
          description: ""
          example: []
          required: false
          schema:
            type: object
            description: ""
            example: []
            properties: {}
        - in: query
          name: filter.include_smart_links
          description: ""
          example: true
          required: false
          schema:
            type: boolean
            description: ""
            example: true
        - in: query
          name: filter.search
          description: Must not be greater than 255 characters.
          example: vvpy
          required: false
          schema:
            type: string
            description: Must not be greater than 255 characters.
            example: vvpy
            nullable: true
        - in: query
          name: filter.tags
          description: Must not be greater than 50 characters.
          example:
            - shjrysoepcxxjnub
          required: false
          schema:
            type: array
            description: Must not be greater than 50 characters.
            example:
              - shjrysoepcxxjnub
            items:
              type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - id: 123
                        trialLinkName: Trial link name
                        url: https://onlyfans.com/username/trial/abc123
                        subscribeDays: 30
                        subscribeCounts: 0
                        claimCounts: 123
                        clicksCounts: 182
                        expiredAt: null
                        createdAt: 2025-01-01T01:01:01+00:00
                        isFinished: false
                        tags:
                          - Instagram
                          - Twitter
                        revenue:
                          total: 123
                          revenuePerSubscriber: 12
                          spendersCount: 16
                          calculatedAt: 2025-01-01T01:01:01+00:00
                          isLoading: false
                        cost:
                          inputMode: null
                          inputValue: null
                          perSub: null
                          perClick: null
                          perPromo: null
                          subscriberSourceCount: 123
                          clickSourceCount: 182
                        links:
                          related:
                            subscribers: https://app.onlyfansapi.com/api/acct_abc123/trial-links/123/subscribers
                            spenders: https://app.onlyfansapi.com/api/acct_abc123/trial-links/123/spenders
                    hasMore: true
                  _pagination:
                    next_page: https://app.onlyfansapi.com/api/acct_abc123/stored/trial-links?limit=10&offset=10
                  _meta:
                    _credits:
                      used: 0
                      balance: 115580
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 997
                      remaining_day: 49990
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - id: 123
                            trialLinkName: Trial link name
                            url: https://onlyfans.com/username/trial/abc123
                            subscribeDays: 30
                            subscribeCounts: 0
                            claimCounts: 123
                            clicksCounts: 182
                            expiredAt: null
                            createdAt: 2025-01-01T01:01:01+00:00
                            isFinished: false
                            tags:
                              - Instagram
                              - Twitter
                            revenue:
                              total: 123
                              revenuePerSubscriber: 12
                              spendersCount: 16
                              calculatedAt: 2025-01-01T01:01:01+00:00
                              isLoading: false
                            cost:
                              inputMode: null
                              inputValue: null
                              perSub: null
                              perClick: null
                              perPromo: null
                              subscriberSourceCount: 123
                              clickSourceCount: 182
                            links:
                              related:
                                subscribers: https://app.onlyfansapi.com/api/acct_abc123/trial-links/123/subscribers
                                spenders: https://app.onlyfansapi.com/api/acct_abc123/trial-links/123/spenders
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            trialLinkName:
                              type: string
                              example: Trial link name
                            url:
                              type: string
                              example: https://onlyfans.com/username/trial/abc123
                            subscribeDays:
                              type: integer
                              example: 30
                            subscribeCounts:
                              type: integer
                              example: 0
                            claimCounts:
                              type: integer
                              example: 123
                            clicksCounts:
                              type: integer
                              example: 182
                            expiredAt:
                              type: string
                              example: null
                              nullable: true
                            createdAt:
                              type: string
                              example: 2025-01-01T01:01:01+00:00
                            isFinished:
                              type: boolean
                              example: false
                            tags:
                              type: array
                              example:
                                - Instagram
                                - Twitter
                              items:
                                type: string
                            revenue:
                              type: object
                              properties:
                                total:
                                  type: number
                                  example: 123
                                revenuePerSubscriber:
                                  type: number
                                  example: 12
                                spendersCount:
                                  type: integer
                                  example: 16
                                calculatedAt:
                                  type: string
                                  example: 2025-01-01T01:01:01+00:00
                                isLoading:
                                  type: boolean
                                  example: false
                            cost:
                              type: object
                              properties:
                                inputMode:
                                  type: string
                                  example: null
                                  nullable: true
                                inputValue:
                                  type: string
                                  example: null
                                  nullable: true
                                perSub:
                                  type: string
                                  example: null
                                  nullable: true
                                perClick:
                                  type: string
                                  example: null
                                  nullable: true
                                perPromo:
                                  type: string
                                  example: null
                                  nullable: true
                                subscriberSourceCount:
                                  type: integer
                                  example: 123
                                clickSourceCount:
                                  type: integer
                                  example: 182
                            links:
                              type: object
                              properties:
                                related:
                                  type: object
                                  properties:
                                    subscribers:
                                      type: string
                                      example: https://app.onlyfansapi.com/api/acct_abc123/trial-links/123/subscribers
                                    spenders:
                                      type: string
                                      example: https://app.onlyfansapi.com/api/acct_abc123/trial-links/123/spenders
                      hasMore:
                        type: boolean
                        example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: https://app.onlyfansapi.com/api/acct_abc123/stored/trial-links?limit=10&offset=10
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 115580
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 49990
      tags:
        - Stored Free Trial Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Calculate Total Transactions (/api-reference/statistics/calculate-total-transactions)

Calculate the total transactions and amounts.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/statistics/total-transactions
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/statistics/total-transactions:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Calculate Total Transactions
      operationId: calculateTotalTransactions
      description: Calculate the total transactions and amounts.
      parameters:
        - in: query
          name: start_date
          description: The start date for the period. Keep empty to calculate everything.
          example: 2025-01-01 00:00:00
          required: false
          schema:
            type: string
            description: The start date for the period. Keep empty to calculate everything.
            example: 2025-01-01 00:00:00
        - in: query
          name: end_date
          description: The end date for the period. Keep empty to calculate everything.
          example: 2025-03-31 23:59:59
          required: false
          schema:
            type: string
            description: The end date for the period. Keep empty to calculate everything.
            example: 2025-03-31 23:59:59
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  total_transactions: 123
                  total_amount: 123.45
                properties:
                  total_transactions:
                    type: integer
                    example: 123
                  total_amount:
                    type: number
                    example: 123.45
      tags:
        - Statistics
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Earnings (/api-reference/statistics/get-earnings)

Get the earnings for a given period.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/statistics/statements/earnings
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/statistics/statements/earnings:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Earnings
      operationId: getEarnings
      description: Get the earnings for a given period.
      parameters:
        - in: query
          name: start_date
          description: The start date for the period.
          example: 2025-01-01 00:00:00
          required: true
          schema:
            type: string
            description: The start date for the period.
            example: 2025-01-01 00:00:00
        - in: query
          name: end_date
          description: The end date for the period.
          example: 2025-03-31 23:59:59
          required: true
          schema:
            type: string
            description: The end date for the period.
            example: 2025-03-31 23:59:59
        - in: query
          name: type
          description: Filter by All / Subscriptions / Tips / Posts / Messages / Streams
          example: total
          required: false
          schema:
            type: string
            description: Filter by All / Subscriptions / Tips / Posts / Messages / Streams
            example: total
            enum:
              - total
              - subscribes
              - tips
              - post
              - messages
              - stream
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    total:
                      delta: -6.9
                      total: 662086.22
                      gross: 827634.52
                      chartCount:
                        - date: 2025-01-01T00:00:00+00:00
                          count: 540
                        - date: 2025-01-02T00:00:00+00:00
                          count: 451
                        - date: 2025-01-03T00:00:00+00:00
                          count: 501
                        - date: 2025-01-04T00:00:00+00:00
                          count: 417
                        - date: 2025-01-05T00:00:00+00:00
                          count: 515
                        - date: 2025-01-06T00:00:00+00:00
                          count: 488
                        - date: 2025-01-07T00:00:00+00:00
                          count: 481
                        - date: 2025-01-08T00:00:00+00:00
                          count: 444
                        - date: 2025-01-09T00:00:00+00:00
                          count: 510
                        - date: 2025-01-10T00:00:00+00:00
                          count: 424
                        - date: 2025-01-11T00:00:00+00:00
                          count: 360
                        - date: 2025-01-12T00:00:00+00:00
                          count: 396
                        - date: 2025-01-13T00:00:00+00:00
                          count: 434
                        - date: 2025-01-14T00:00:00+00:00
                          count: 392
                        - date: 2025-01-15T00:00:00+00:00
                          count: 368
                        - date: 2025-01-16T00:00:00+00:00
                          count: 402
                        - date: 2025-01-17T00:00:00+00:00
                          count: 393
                        - date: 2025-01-18T00:00:00+00:00
                          count: 360
                        - date: 2025-01-19T00:00:00+00:00
                          count: 438
                        - date: 2025-01-20T00:00:00+00:00
                          count: 420
                        - date: 2025-01-21T00:00:00+00:00
                          count: 314
                        - date: 2025-01-22T00:00:00+00:00
                          count: 384
                        - date: 2025-01-23T00:00:00+00:00
                          count: 408
                        - date: 2025-01-24T00:00:00+00:00
                          count: 384
                        - date: 2025-01-25T00:00:00+00:00
                          count: 468
                        - date: 2025-01-26T00:00:00+00:00
                          count: 609
                        - date: 2025-01-27T00:00:00+00:00
                          count: 514
                        - date: 2025-01-28T00:00:00+00:00
                          count: 438
                        - date: 2025-01-29T00:00:00+00:00
                          count: 421
                        - date: 2025-01-30T00:00:00+00:00
                          count: 494
                        - date: 2025-01-31T00:00:00+00:00
                          count: 487
                        - date: 2025-02-01T00:00:00+00:00
                          count: 523
                        - date: 2025-02-02T00:00:00+00:00
                          count: 572
                        - date: 2025-02-03T00:00:00+00:00
                          count: 468
                        - date: 2025-02-04T00:00:00+00:00
                          count: 433
                        - date: 2025-02-05T00:00:00+00:00
                          count: 544
                        - date: 2025-02-06T00:00:00+00:00
                          count: 641
                        - date: 2025-02-07T00:00:00+00:00
                          count: 524
                        - date: 2025-02-08T00:00:00+00:00
                          count: 522
                        - date: 2025-02-09T00:00:00+00:00
                          count: 454
                        - date: 2025-02-10T00:00:00+00:00
                          count: 596
                        - date: 2025-02-11T00:00:00+00:00
                          count: 540
                        - date: 2025-02-12T00:00:00+00:00
                          count: 466
                        - date: 2025-02-13T00:00:00+00:00
                          count: 519
                        - date: 2025-02-14T00:00:00+00:00
                          count: 513
                        - date: 2025-02-15T00:00:00+00:00
                          count: 487
                        - date: 2025-02-16T00:00:00+00:00
                          count: 412
                        - date: 2025-02-17T00:00:00+00:00
                          count: 404
                        - date: 2025-02-18T00:00:00+00:00
                          count: 472
                        - date: 2025-02-19T00:00:00+00:00
                          count: 355
                        - date: 2025-02-20T00:00:00+00:00
                          count: 481
                        - date: 2025-02-21T00:00:00+00:00
                          count: 485
                        - date: 2025-02-22T00:00:00+00:00
                          count: 439
                        - date: 2025-02-23T00:00:00+00:00
                          count: 412
                        - date: 2025-02-24T00:00:00+00:00
                          count: 434
                        - date: 2025-02-25T00:00:00+00:00
                          count: 397
                        - date: 2025-02-26T00:00:00+00:00
                          count: 368
                        - date: 2025-02-27T00:00:00+00:00
                          count: 518
                        - date: 2025-02-28T00:00:00+00:00
                          count: 565
                        - date: 2025-03-01T00:00:00+00:00
                          count: 564
                        - date: 2025-03-02T00:00:00+00:00
                          count: 581
                        - date: 2025-03-03T00:00:00+00:00
                          count: 444
                        - date: 2025-03-04T00:00:00+00:00
                          count: 457
                        - date: 2025-03-05T00:00:00+00:00
                          count: 507
                        - date: 2025-03-06T00:00:00+00:00
                          count: 510
                        - date: 2025-03-07T00:00:00+00:00
                          count: 474
                        - date: 2025-03-08T00:00:00+00:00
                          count: 543
                        - date: 2025-03-09T00:00:00+00:00
                          count: 529
                        - date: 2025-03-10T00:00:00+00:00
                          count: 520
                        - date: 2025-03-11T00:00:00+00:00
                          count: 498
                        - date: 2025-03-12T00:00:00+00:00
                          count: 457
                        - date: 2025-03-13T00:00:00+00:00
                          count: 497
                        - date: 2025-03-14T00:00:00+00:00
                          count: 532
                        - date: 2025-03-15T00:00:00+00:00
                          count: 491
                        - date: 2025-03-16T00:00:00+00:00
                          count: 413
                        - date: 2025-03-17T00:00:00+00:00
                          count: 426
                        - date: 2025-03-18T00:00:00+00:00
                          count: 491
                        - date: 2025-03-19T00:00:00+00:00
                          count: 386
                        - date: 2025-03-20T00:00:00+00:00
                          count: 476
                        - date: 2025-03-21T00:00:00+00:00
                          count: 420
                        - date: 2025-03-22T00:00:00+00:00
                          count: 426
                        - date: 2025-03-23T00:00:00+00:00
                          count: 533
                        - date: 2025-03-24T00:00:00+00:00
                          count: 406
                        - date: 2025-03-25T00:00:00+00:00
                          count: 400
                        - date: 2025-03-26T00:00:00+00:00
                          count: 435
                        - date: 2025-03-27T00:00:00+00:00
                          count: 514
                        - date: 2025-03-28T00:00:00+00:00
                          count: 503
                        - date: 2025-03-29T00:00:00+00:00
                          count: 446
                        - date: 2025-03-30T00:00:00+00:00
                          count: 437
                        - date: 2025-03-31T00:00:00+00:00
                          count: 415
                      chartAmount:
                        - date: 2025-01-01T00:00:00+00:00
                          count: 10051.89
                        - date: 2025-01-02T00:00:00+00:00
                          count: 7044.43
                        - date: 2025-01-03T00:00:00+00:00
                          count: 9070.46
                        - date: 2025-01-04T00:00:00+00:00
                          count: 7575.49
                        - date: 2025-01-05T00:00:00+00:00
                          count: 7459.01
                        - date: 2025-01-06T00:00:00+00:00
                          count: 8472.68
                        - date: 2025-01-07T00:00:00+00:00
                          count: 6410.23
                        - date: 2025-01-08T00:00:00+00:00
                          count: 6336.6
                        - date: 2025-01-09T00:00:00+00:00
                          count: 8475.93
                        - date: 2025-01-10T00:00:00+00:00
                          count: 7673.4
                        - date: 2025-01-11T00:00:00+00:00
                          count: 7666.22
                        - date: 2025-01-12T00:00:00+00:00
                          count: 8126.65
                        - date: 2025-01-13T00:00:00+00:00
                          count: 6278.71
                        - date: 2025-01-14T00:00:00+00:00
                          count: 7210.6
                        - date: 2025-01-15T00:00:00+00:00
                          count: 4610.57
                        - date: 2025-01-16T00:00:00+00:00
                          count: 5739.87
                        - date: 2025-01-17T00:00:00+00:00
                          count: 8435.22
                        - date: 2025-01-18T00:00:00+00:00
                          count: 5237.74
                        - date: 2025-01-19T00:00:00+00:00
                          count: 7315.44
                        - date: 2025-01-20T00:00:00+00:00
                          count: 7325.59
                        - date: 2025-01-21T00:00:00+00:00
                          count: 4510.83
                        - date: 2025-01-22T00:00:00+00:00
                          count: 6901.88
                        - date: 2025-01-23T00:00:00+00:00
                          count: 5442.49
                        - date: 2025-01-24T00:00:00+00:00
                          count: 6517.01
                        - date: 2025-01-25T00:00:00+00:00
                          count: 6882.58
                        - date: 2025-01-26T00:00:00+00:00
                          count: 8778.25
                        - date: 2025-01-27T00:00:00+00:00
                          count: 7759.99
                        - date: 2025-01-28T00:00:00+00:00
                          count: 6750.44
                        - date: 2025-01-29T00:00:00+00:00
                          count: 6338.93
                        - date: 2025-01-30T00:00:00+00:00
                          count: 7249.22
                        - date: 2025-01-31T00:00:00+00:00
                          count: 6299.92
                        - date: 2025-02-01T00:00:00+00:00
                          count: 8327.3
                        - date: 2025-02-02T00:00:00+00:00
                          count: 7675.32
                        - date: 2025-02-03T00:00:00+00:00
                          count: 7153.73
                        - date: 2025-02-04T00:00:00+00:00
                          count: 6711.74
                        - date: 2025-02-05T00:00:00+00:00
                          count: 7334.76
                        - date: 2025-02-06T00:00:00+00:00
                          count: 13641.27
                        - date: 2025-02-07T00:00:00+00:00
                          count: 9280.8
                        - date: 2025-02-08T00:00:00+00:00
                          count: 7978.69
                        - date: 2025-02-09T00:00:00+00:00
                          count: 8561.71
                        - date: 2025-02-10T00:00:00+00:00
                          count: 6979.16
                        - date: 2025-02-11T00:00:00+00:00
                          count: 7040.23
                        - date: 2025-02-12T00:00:00+00:00
                          count: 6701.16
                        - date: 2025-02-13T00:00:00+00:00
                          count: 7418.89
                        - date: 2025-02-14T00:00:00+00:00
                          count: 9174.97
                        - date: 2025-02-15T00:00:00+00:00
                          count: 8956.52
                        - date: 2025-02-16T00:00:00+00:00
                          count: 6561.58
                        - date: 2025-02-17T00:00:00+00:00
                          count: 5060.88
                        - date: 2025-02-18T00:00:00+00:00
                          count: 7721.78
                        - date: 2025-02-19T00:00:00+00:00
                          count: 6096.49
                        - date: 2025-02-20T00:00:00+00:00
                          count: 7017.78
                        - date: 2025-02-21T00:00:00+00:00
                          count: 9542.37
                        - date: 2025-02-22T00:00:00+00:00
                          count: 6882.54
                        - date: 2025-02-23T00:00:00+00:00
                          count: 5805.24
                        - date: 2025-02-24T00:00:00+00:00
                          count: 6612.35
                        - date: 2025-02-25T00:00:00+00:00
                          count: 4801.5
                        - date: 2025-02-26T00:00:00+00:00
                          count: 5793.31
                        - date: 2025-02-27T00:00:00+00:00
                          count: 7420.45
                        - date: 2025-02-28T00:00:00+00:00
                          count: 7238.34
                        - date: 2025-03-01T00:00:00+00:00
                          count: 8843.12
                        - date: 2025-03-02T00:00:00+00:00
                          count: 8087.79
                        - date: 2025-03-03T00:00:00+00:00
                          count: 7389.51
                        - date: 2025-03-04T00:00:00+00:00
                          count: 5521.31
                        - date: 2025-03-05T00:00:00+00:00
                          count: 8213.56
                        - date: 2025-03-06T00:00:00+00:00
                          count: 8016.33
                        - date: 2025-03-07T00:00:00+00:00
                          count: 7856.66
                        - date: 2025-03-08T00:00:00+00:00
                          count: 7283.95
                        - date: 2025-03-09T00:00:00+00:00
                          count: 9228.49
                        - date: 2025-03-10T00:00:00+00:00
                          count: 7571.83
                        - date: 2025-03-11T00:00:00+00:00
                          count: 7476.63
                        - date: 2025-03-12T00:00:00+00:00
                          count: 6336.17
                        - date: 2025-03-13T00:00:00+00:00
                          count: 8253.78
                        - date: 2025-03-14T00:00:00+00:00
                          count: 7627.9
                        - date: 2025-03-15T00:00:00+00:00
                          count: 7304.9
                        - date: 2025-03-16T00:00:00+00:00
                          count: 7900.93
                        - date: 2025-03-17T00:00:00+00:00
                          count: 6035.48
                        - date: 2025-03-18T00:00:00+00:00
                          count: 8107.57
                        - date: 2025-03-19T00:00:00+00:00
                          count: 6584.91
                        - date: 2025-03-20T00:00:00+00:00
                          count: 7021.49
                        - date: 2025-03-21T00:00:00+00:00
                          count: 6801.75
                        - date: 2025-03-22T00:00:00+00:00
                          count: 7950.66
                        - date: 2025-03-23T00:00:00+00:00
                          count: 9653.96
                        - date: 2025-03-24T00:00:00+00:00
                          count: 6069.97
                        - date: 2025-03-25T00:00:00+00:00
                          count: 6746.01
                        - date: 2025-03-26T00:00:00+00:00
                          count: 6619.57
                        - date: 2025-03-27T00:00:00+00:00
                          count: 8570.96
                        - date: 2025-03-28T00:00:00+00:00
                          count: 8294.75
                        - date: 2025-03-29T00:00:00+00:00
                          count: 7005.74
                        - date: 2025-03-30T00:00:00+00:00
                          count: 7233.87
                        - date: 2025-03-31T00:00:00+00:00
                          count: 7037.54
                  _meta:
                    _credits:
                      used: 1
                      balance: 25579
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 5000
                      remaining_minute: 997
                      remaining_day: 4981
                properties:
                  data:
                    type: object
                    properties:
                      total:
                        type: object
                        properties:
                          delta:
                            type: number
                            example: -6.9
                          total:
                            type: number
                            example: 662086.22
                          gross:
                            type: number
                            example: 827634.52
                          chartCount:
                            type: array
                            example:
                              - date: 2025-01-01T00:00:00+00:00
                                count: 540
                              - date: 2025-01-02T00:00:00+00:00
                                count: 451
                              - date: 2025-01-03T00:00:00+00:00
                                count: 501
                              - date: 2025-01-04T00:00:00+00:00
                                count: 417
                              - date: 2025-01-05T00:00:00+00:00
                                count: 515
                              - date: 2025-01-06T00:00:00+00:00
                                count: 488
                              - date: 2025-01-07T00:00:00+00:00
                                count: 481
                              - date: 2025-01-08T00:00:00+00:00
                                count: 444
                              - date: 2025-01-09T00:00:00+00:00
                                count: 510
                              - date: 2025-01-10T00:00:00+00:00
                                count: 424
                              - date: 2025-01-11T00:00:00+00:00
                                count: 360
                              - date: 2025-01-12T00:00:00+00:00
                                count: 396
                              - date: 2025-01-13T00:00:00+00:00
                                count: 434
                              - date: 2025-01-14T00:00:00+00:00
                                count: 392
                              - date: 2025-01-15T00:00:00+00:00
                                count: 368
                              - date: 2025-01-16T00:00:00+00:00
                                count: 402
                              - date: 2025-01-17T00:00:00+00:00
                                count: 393
                              - date: 2025-01-18T00:00:00+00:00
                                count: 360
                              - date: 2025-01-19T00:00:00+00:00
                                count: 438
                              - date: 2025-01-20T00:00:00+00:00
                                count: 420
                              - date: 2025-01-21T00:00:00+00:00
                                count: 314
                              - date: 2025-01-22T00:00:00+00:00
                                count: 384
                              - date: 2025-01-23T00:00:00+00:00
                                count: 408
                              - date: 2025-01-24T00:00:00+00:00
                                count: 384
                              - date: 2025-01-25T00:00:00+00:00
                                count: 468
                              - date: 2025-01-26T00:00:00+00:00
                                count: 609
                              - date: 2025-01-27T00:00:00+00:00
                                count: 514
                              - date: 2025-01-28T00:00:00+00:00
                                count: 438
                              - date: 2025-01-29T00:00:00+00:00
                                count: 421
                              - date: 2025-01-30T00:00:00+00:00
                                count: 494
                              - date: 2025-01-31T00:00:00+00:00
                                count: 487
                              - date: 2025-02-01T00:00:00+00:00
                                count: 523
                              - date: 2025-02-02T00:00:00+00:00
                                count: 572
                              - date: 2025-02-03T00:00:00+00:00
                                count: 468
                              - date: 2025-02-04T00:00:00+00:00
                                count: 433
                              - date: 2025-02-05T00:00:00+00:00
                                count: 544
                              - date: 2025-02-06T00:00:00+00:00
                                count: 641
                              - date: 2025-02-07T00:00:00+00:00
                                count: 524
                              - date: 2025-02-08T00:00:00+00:00
                                count: 522
                              - date: 2025-02-09T00:00:00+00:00
                                count: 454
                              - date: 2025-02-10T00:00:00+00:00
                                count: 596
                              - date: 2025-02-11T00:00:00+00:00
                                count: 540
                              - date: 2025-02-12T00:00:00+00:00
                                count: 466
                              - date: 2025-02-13T00:00:00+00:00
                                count: 519
                              - date: 2025-02-14T00:00:00+00:00
                                count: 513
                              - date: 2025-02-15T00:00:00+00:00
                                count: 487
                              - date: 2025-02-16T00:00:00+00:00
                                count: 412
                              - date: 2025-02-17T00:00:00+00:00
                                count: 404
                              - date: 2025-02-18T00:00:00+00:00
                                count: 472
                              - date: 2025-02-19T00:00:00+00:00
                                count: 355
                              - date: 2025-02-20T00:00:00+00:00
                                count: 481
                              - date: 2025-02-21T00:00:00+00:00
                                count: 485
                              - date: 2025-02-22T00:00:00+00:00
                                count: 439
                              - date: 2025-02-23T00:00:00+00:00
                                count: 412
                              - date: 2025-02-24T00:00:00+00:00
                                count: 434
                              - date: 2025-02-25T00:00:00+00:00
                                count: 397
                              - date: 2025-02-26T00:00:00+00:00
                                count: 368
                              - date: 2025-02-27T00:00:00+00:00
                                count: 518
                              - date: 2025-02-28T00:00:00+00:00
                                count: 565
                              - date: 2025-03-01T00:00:00+00:00
                                count: 564
                              - date: 2025-03-02T00:00:00+00:00
                                count: 581
                              - date: 2025-03-03T00:00:00+00:00
                                count: 444
                              - date: 2025-03-04T00:00:00+00:00
                                count: 457
                              - date: 2025-03-05T00:00:00+00:00
                                count: 507
                              - date: 2025-03-06T00:00:00+00:00
                                count: 510
                              - date: 2025-03-07T00:00:00+00:00
                                count: 474
                              - date: 2025-03-08T00:00:00+00:00
                                count: 543
                              - date: 2025-03-09T00:00:00+00:00
                                count: 529
                              - date: 2025-03-10T00:00:00+00:00
                                count: 520
                              - date: 2025-03-11T00:00:00+00:00
                                count: 498
                              - date: 2025-03-12T00:00:00+00:00
                                count: 457
                              - date: 2025-03-13T00:00:00+00:00
                                count: 497
                              - date: 2025-03-14T00:00:00+00:00
                                count: 532
                              - date: 2025-03-15T00:00:00+00:00
                                count: 491
                              - date: 2025-03-16T00:00:00+00:00
                                count: 413
                              - date: 2025-03-17T00:00:00+00:00
                                count: 426
                              - date: 2025-03-18T00:00:00+00:00
                                count: 491
                              - date: 2025-03-19T00:00:00+00:00
                                count: 386
                              - date: 2025-03-20T00:00:00+00:00
                                count: 476
                              - date: 2025-03-21T00:00:00+00:00
                                count: 420
                              - date: 2025-03-22T00:00:00+00:00
                                count: 426
                              - date: 2025-03-23T00:00:00+00:00
                                count: 533
                              - date: 2025-03-24T00:00:00+00:00
                                count: 406
                              - date: 2025-03-25T00:00:00+00:00
                                count: 400
                              - date: 2025-03-26T00:00:00+00:00
                                count: 435
                              - date: 2025-03-27T00:00:00+00:00
                                count: 514
                              - date: 2025-03-28T00:00:00+00:00
                                count: 503
                              - date: 2025-03-29T00:00:00+00:00
                                count: 446
                              - date: 2025-03-30T00:00:00+00:00
                                count: 437
                              - date: 2025-03-31T00:00:00+00:00
                                count: 415
                            items:
                              type: object
                              properties:
                                date:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                count:
                                  type: integer
                                  example: 540
                          chartAmount:
                            type: array
                            example:
                              - date: 2025-01-01T00:00:00+00:00
                                count: 10051.89
                              - date: 2025-01-02T00:00:00+00:00
                                count: 7044.43
                              - date: 2025-01-03T00:00:00+00:00
                                count: 9070.46
                              - date: 2025-01-04T00:00:00+00:00
                                count: 7575.49
                              - date: 2025-01-05T00:00:00+00:00
                                count: 7459.01
                              - date: 2025-01-06T00:00:00+00:00
                                count: 8472.68
                              - date: 2025-01-07T00:00:00+00:00
                                count: 6410.23
                              - date: 2025-01-08T00:00:00+00:00
                                count: 6336.6
                              - date: 2025-01-09T00:00:00+00:00
                                count: 8475.93
                              - date: 2025-01-10T00:00:00+00:00
                                count: 7673.4
                              - date: 2025-01-11T00:00:00+00:00
                                count: 7666.22
                              - date: 2025-01-12T00:00:00+00:00
                                count: 8126.65
                              - date: 2025-01-13T00:00:00+00:00
                                count: 6278.71
                              - date: 2025-01-14T00:00:00+00:00
                                count: 7210.6
                              - date: 2025-01-15T00:00:00+00:00
                                count: 4610.57
                              - date: 2025-01-16T00:00:00+00:00
                                count: 5739.87
                              - date: 2025-01-17T00:00:00+00:00
                                count: 8435.22
                              - date: 2025-01-18T00:00:00+00:00
                                count: 5237.74
                              - date: 2025-01-19T00:00:00+00:00
                                count: 7315.44
                              - date: 2025-01-20T00:00:00+00:00
                                count: 7325.59
                              - date: 2025-01-21T00:00:00+00:00
                                count: 4510.83
                              - date: 2025-01-22T00:00:00+00:00
                                count: 6901.88
                              - date: 2025-01-23T00:00:00+00:00
                                count: 5442.49
                              - date: 2025-01-24T00:00:00+00:00
                                count: 6517.01
                              - date: 2025-01-25T00:00:00+00:00
                                count: 6882.58
                              - date: 2025-01-26T00:00:00+00:00
                                count: 8778.25
                              - date: 2025-01-27T00:00:00+00:00
                                count: 7759.99
                              - date: 2025-01-28T00:00:00+00:00
                                count: 6750.44
                              - date: 2025-01-29T00:00:00+00:00
                                count: 6338.93
                              - date: 2025-01-30T00:00:00+00:00
                                count: 7249.22
                              - date: 2025-01-31T00:00:00+00:00
                                count: 6299.92
                              - date: 2025-02-01T00:00:00+00:00
                                count: 8327.3
                              - date: 2025-02-02T00:00:00+00:00
                                count: 7675.32
                              - date: 2025-02-03T00:00:00+00:00
                                count: 7153.73
                              - date: 2025-02-04T00:00:00+00:00
                                count: 6711.74
                              - date: 2025-02-05T00:00:00+00:00
                                count: 7334.76
                              - date: 2025-02-06T00:00:00+00:00
                                count: 13641.27
                              - date: 2025-02-07T00:00:00+00:00
                                count: 9280.8
                              - date: 2025-02-08T00:00:00+00:00
                                count: 7978.69
                              - date: 2025-02-09T00:00:00+00:00
                                count: 8561.71
                              - date: 2025-02-10T00:00:00+00:00
                                count: 6979.16
                              - date: 2025-02-11T00:00:00+00:00
                                count: 7040.23
                              - date: 2025-02-12T00:00:00+00:00
                                count: 6701.16
                              - date: 2025-02-13T00:00:00+00:00
                                count: 7418.89
                              - date: 2025-02-14T00:00:00+00:00
                                count: 9174.97
                              - date: 2025-02-15T00:00:00+00:00
                                count: 8956.52
                              - date: 2025-02-16T00:00:00+00:00
                                count: 6561.58
                              - date: 2025-02-17T00:00:00+00:00
                                count: 5060.88
                              - date: 2025-02-18T00:00:00+00:00
                                count: 7721.78
                              - date: 2025-02-19T00:00:00+00:00
                                count: 6096.49
                              - date: 2025-02-20T00:00:00+00:00
                                count: 7017.78
                              - date: 2025-02-21T00:00:00+00:00
                                count: 9542.37
                              - date: 2025-02-22T00:00:00+00:00
                                count: 6882.54
                              - date: 2025-02-23T00:00:00+00:00
                                count: 5805.24
                              - date: 2025-02-24T00:00:00+00:00
                                count: 6612.35
                              - date: 2025-02-25T00:00:00+00:00
                                count: 4801.5
                              - date: 2025-02-26T00:00:00+00:00
                                count: 5793.31
                              - date: 2025-02-27T00:00:00+00:00
                                count: 7420.45
                              - date: 2025-02-28T00:00:00+00:00
                                count: 7238.34
                              - date: 2025-03-01T00:00:00+00:00
                                count: 8843.12
                              - date: 2025-03-02T00:00:00+00:00
                                count: 8087.79
                              - date: 2025-03-03T00:00:00+00:00
                                count: 7389.51
                              - date: 2025-03-04T00:00:00+00:00
                                count: 5521.31
                              - date: 2025-03-05T00:00:00+00:00
                                count: 8213.56
                              - date: 2025-03-06T00:00:00+00:00
                                count: 8016.33
                              - date: 2025-03-07T00:00:00+00:00
                                count: 7856.66
                              - date: 2025-03-08T00:00:00+00:00
                                count: 7283.95
                              - date: 2025-03-09T00:00:00+00:00
                                count: 9228.49
                              - date: 2025-03-10T00:00:00+00:00
                                count: 7571.83
                              - date: 2025-03-11T00:00:00+00:00
                                count: 7476.63
                              - date: 2025-03-12T00:00:00+00:00
                                count: 6336.17
                              - date: 2025-03-13T00:00:00+00:00
                                count: 8253.78
                              - date: 2025-03-14T00:00:00+00:00
                                count: 7627.9
                              - date: 2025-03-15T00:00:00+00:00
                                count: 7304.9
                              - date: 2025-03-16T00:00:00+00:00
                                count: 7900.93
                              - date: 2025-03-17T00:00:00+00:00
                                count: 6035.48
                              - date: 2025-03-18T00:00:00+00:00
                                count: 8107.57
                              - date: 2025-03-19T00:00:00+00:00
                                count: 6584.91
                              - date: 2025-03-20T00:00:00+00:00
                                count: 7021.49
                              - date: 2025-03-21T00:00:00+00:00
                                count: 6801.75
                              - date: 2025-03-22T00:00:00+00:00
                                count: 7950.66
                              - date: 2025-03-23T00:00:00+00:00
                                count: 9653.96
                              - date: 2025-03-24T00:00:00+00:00
                                count: 6069.97
                              - date: 2025-03-25T00:00:00+00:00
                                count: 6746.01
                              - date: 2025-03-26T00:00:00+00:00
                                count: 6619.57
                              - date: 2025-03-27T00:00:00+00:00
                                count: 8570.96
                              - date: 2025-03-28T00:00:00+00:00
                                count: 8294.75
                              - date: 2025-03-29T00:00:00+00:00
                                count: 7005.74
                              - date: 2025-03-30T00:00:00+00:00
                                count: 7233.87
                              - date: 2025-03-31T00:00:00+00:00
                                count: 7037.54
                            items:
                              type: object
                              properties:
                                date:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                count:
                                  type: number
                                  example: 10051.89
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 25579
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 5000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 4981
      tags:
        - Statistics
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Profile Visitors (/api-reference/statistics/get-profile-visitors)

Get the number of profile visitors for a given period.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/statistics/reach/profile-visitors
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/statistics/reach/profile-visitors:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Profile Visitors
      operationId: getProfileVisitors
      description: Get the number of profile visitors for a given period.
      parameters:
        - in: query
          name: start_date
          description: The start date for the period.
          example: 2025-01-01 00:00:00
          required: true
          schema:
            type: string
            description: The start date for the period.
            example: 2025-01-01 00:00:00
        - in: query
          name: end_date
          description: The end date for the period.
          example: 2025-03-31 23:59:59
          required: true
          schema:
            type: string
            description: The end date for the period.
            example: 2025-03-31 23:59:59
        - in: query
          name: type
          description: Filter all / users / guests
          example: total
          required: false
          schema:
            type: string
            description: Filter all / users / guests
            example: total
            enum:
              - total
              - users
              - guests
            nullable: true
        - in: query
          name: filter
          description: Optionally, filter the results by `chart` or `topCountries`. See
            example responses.
          example: chart
          required: false
          schema:
            type: string
            description: Optionally, filter the results by `chart` or `topCountries`. See
              example responses.
            example: chart
            enum:
              - chart
              - topCountries
            nullable: true
        - in: query
          name: limit
          description: Number of results to return
          example: 10
          required: false
          schema:
            type: integer
            description: Number of results to return
            example: 10
            nullable: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                oneOf:
                  - description: No filter
                    type: object
                    example:
                      data:
                        isAvailable: true
                        topCountries:
                          hasMore: true
                          totals:
                            total: 123
                            guests: "123"
                            users: "123"
                            subscribers: 123
                          rows:
                            - rank: 1
                              countryName: Australia
                              countryCode: AU
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            - rank: 2
                              countryName: United States
                              countryCode: US
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            - rank: 3
                              countryName: Spain
                              countryCode: ES
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            - rank: 4
                              countryName: United Kingdom
                              countryCode: GB
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            - rank: 5
                              countryName: Austria
                              countryCode: AT
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            - rank: 6
                              countryName: Norway
                              countryCode: NO
                              viewsCount:
                                total: 21
                                guests: 21
                                users: 0
                                subscribers: 0
                            - rank: 7
                              countryName: Singapore
                              countryCode: SG
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            - rank: 8
                              countryName: Germany
                              countryCode: DE
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            - rank: 9
                              countryName: Mexico
                              countryCode: MX
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            - rank: 10
                              countryName: Israel
                              countryCode: IL
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            - rank: 11
                              countryName: Others
                              countryCode: ""
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                        topDurationUsers:
                          totals:
                            total: 123
                            guests: "123"
                            users: "123"
                            subscribers: 123
                        chart:
                          visitors:
                            - date: 2025-01-01T00:00:00+00:00
                              count: 123
                          duration:
                            - date: 2025-01-01T00:00:00+00:00
                              count: 123
                        total:
                          current: "123"
                          delta: 12.3
                        hasStats: true
                      _meta:
                        _credits:
                          used: 1
                          balance: 999999818
                          note: Always
                        _cache:
                          is_cached: false
                          note: Cache disabled for this endpoint
                        _rate_limits:
                          limit_minute: 1000
                          limit_day: 50000
                          remaining_minute: 999
                          remaining_day: 49963
                    properties:
                      data:
                        type: object
                        properties:
                          isAvailable:
                            type: boolean
                            example: true
                          topCountries:
                            type: object
                            properties:
                              hasMore:
                                type: boolean
                                example: true
                              totals:
                                type: object
                                properties:
                                  total:
                                    type: integer
                                    example: 123
                                  guests:
                                    type: string
                                    example: "123"
                                  users:
                                    type: string
                                    example: "123"
                                  subscribers:
                                    type: integer
                                    example: 123
                              rows:
                                type: array
                                example:
                                  - rank: 1
                                    countryName: Australia
                                    countryCode: AU
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  - rank: 2
                                    countryName: United States
                                    countryCode: US
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  - rank: 3
                                    countryName: Spain
                                    countryCode: ES
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  - rank: 4
                                    countryName: United Kingdom
                                    countryCode: GB
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  - rank: 5
                                    countryName: Austria
                                    countryCode: AT
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  - rank: 6
                                    countryName: Norway
                                    countryCode: NO
                                    viewsCount:
                                      total: 21
                                      guests: 21
                                      users: 0
                                      subscribers: 0
                                  - rank: 7
                                    countryName: Singapore
                                    countryCode: SG
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  - rank: 8
                                    countryName: Germany
                                    countryCode: DE
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  - rank: 9
                                    countryName: Mexico
                                    countryCode: MX
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  - rank: 10
                                    countryName: Israel
                                    countryCode: IL
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  - rank: 11
                                    countryName: Others
                                    countryCode: ""
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                items:
                                  type: object
                                  properties:
                                    rank:
                                      type: integer
                                      example: 1
                                    countryName:
                                      type: string
                                      example: Australia
                                    countryCode:
                                      type: string
                                      example: AU
                                    viewsCount:
                                      type: object
                                      properties:
                                        total:
                                          type: integer
                                          example: 123
                                        guests:
                                          type: integer
                                          example: 123
                                        users:
                                          type: integer
                                          example: 123
                                        subscribers:
                                          type: integer
                                          example: 123
                          topDurationUsers:
                            type: object
                            properties:
                              totals:
                                type: object
                                properties:
                                  total:
                                    type: integer
                                    example: 123
                                  guests:
                                    type: string
                                    example: "123"
                                  users:
                                    type: string
                                    example: "123"
                                  subscribers:
                                    type: integer
                                    example: 123
                          chart:
                            type: object
                            properties:
                              visitors:
                                type: array
                                example:
                                  - date: 2025-01-01T00:00:00+00:00
                                    count: 123
                                items:
                                  type: object
                                  properties:
                                    date:
                                      type: string
                                      example: 2025-01-01T00:00:00+00:00
                                    count:
                                      type: integer
                                      example: 123
                              duration:
                                type: array
                                example:
                                  - date: 2025-01-01T00:00:00+00:00
                                    count: 123
                                items:
                                  type: object
                                  properties:
                                    date:
                                      type: string
                                      example: 2025-01-01T00:00:00+00:00
                                    count:
                                      type: integer
                                      example: 123
                          total:
                            type: object
                            properties:
                              current:
                                type: string
                                example: "123"
                              delta:
                                type: number
                                example: 12.3
                          hasStats:
                            type: boolean
                            example: true
                      _meta:
                        type: object
                        properties:
                          _credits:
                            type: object
                            properties:
                              used:
                                type: integer
                                example: 1
                              balance:
                                type: integer
                                example: 999999818
                              note:
                                type: string
                                example: Always
                          _cache:
                            type: object
                            properties:
                              is_cached:
                                type: boolean
                                example: false
                              note:
                                type: string
                                example: Cache disabled for this endpoint
                          _rate_limits:
                            type: object
                            properties:
                              limit_minute:
                                type: integer
                                example: 1000
                              limit_day:
                                type: integer
                                example: 50000
                              remaining_minute:
                                type: integer
                                example: 999
                              remaining_day:
                                type: integer
                                example: 49963
                  - description: Chart filter
                    type: object
                    example:
                      data:
                        isAvailable: true
                        chart:
                          visitors:
                            - date: 2025-01-01T00:00:00+00:00
                              count: 123
                          duration:
                            - date: 2025-01-01T00:00:00+00:00
                              count: 123
                        total:
                          current: "123"
                          delta: 12.3
                        hasStats: false
                      _meta:
                        _credits:
                          used: 1
                          balance: 999999815
                          note: Always
                        _cache:
                          is_cached: false
                          note: Cache disabled for this endpoint
                        _rate_limits:
                          limit_minute: 1000
                          limit_day: 50000
                          remaining_minute: 999
                          remaining_day: 49960
                    properties:
                      data:
                        type: object
                        properties:
                          isAvailable:
                            type: boolean
                            example: true
                          chart:
                            type: object
                            properties:
                              visitors:
                                type: array
                                example:
                                  - date: 2025-01-01T00:00:00+00:00
                                    count: 123
                                items:
                                  type: object
                                  properties:
                                    date:
                                      type: string
                                      example: 2025-01-01T00:00:00+00:00
                                    count:
                                      type: integer
                                      example: 123
                              duration:
                                type: array
                                example:
                                  - date: 2025-01-01T00:00:00+00:00
                                    count: 123
                                items:
                                  type: object
                                  properties:
                                    date:
                                      type: string
                                      example: 2025-01-01T00:00:00+00:00
                                    count:
                                      type: integer
                                      example: 123
                          total:
                            type: object
                            properties:
                              current:
                                type: string
                                example: "123"
                              delta:
                                type: number
                                example: 12.3
                          hasStats:
                            type: boolean
                            example: false
                      _meta:
                        type: object
                        properties:
                          _credits:
                            type: object
                            properties:
                              used:
                                type: integer
                                example: 1
                              balance:
                                type: integer
                                example: 999999815
                              note:
                                type: string
                                example: Always
                          _cache:
                            type: object
                            properties:
                              is_cached:
                                type: boolean
                                example: false
                              note:
                                type: string
                                example: Cache disabled for this endpoint
                          _rate_limits:
                            type: object
                            properties:
                              limit_minute:
                                type: integer
                                example: 1000
                              limit_day:
                                type: integer
                                example: 50000
                              remaining_minute:
                                type: integer
                                example: 999
                              remaining_day:
                                type: integer
                                example: 49960
                  - description: Top countries filter
                    type: object
                    example:
                      data:
                        isAvailable: true
                        topCountries:
                          hasMore: true
                          totals:
                            total: 123
                            guests: "123"
                            users: "123"
                            subscribers: 123
                          rows:
                            - rank: 1
                              countryName: United States
                              countryCode: US
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            - rank: 2
                              countryName: Australia
                              countryCode: AU
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            - rank: 3
                              countryName: Canada
                              countryCode: CA
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            - rank: 4
                              countryName: United Kingdom
                              countryCode: GB
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            - rank: 5
                              countryName: Germany
                              countryCode: DE
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            - rank: 6
                              countryName: Mexico
                              countryCode: MX
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            - rank: 7
                              countryName: Dominican Republic
                              countryCode: DO
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            - rank: 8
                              countryName: Brazil
                              countryCode: BR
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            - rank: 9
                              countryName: Italy
                              countryCode: IT
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            - rank: 10
                              countryName: Denmark
                              countryCode: DK
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            - rank: 11
                              countryName: Others
                              countryCode: ""
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                        hasStats: true
                      _meta:
                        _credits:
                          used: 1
                          balance: 999999814
                          note: Always
                        _cache:
                          is_cached: false
                          note: Cache disabled for this endpoint
                        _rate_limits:
                          limit_minute: 1000
                          limit_day: 50000
                          remaining_minute: 998
                          remaining_day: 49959
                    properties:
                      data:
                        type: object
                        properties:
                          isAvailable:
                            type: boolean
                            example: true
                          topCountries:
                            type: object
                            properties:
                              hasMore:
                                type: boolean
                                example: true
                              totals:
                                type: object
                                properties:
                                  total:
                                    type: integer
                                    example: 123
                                  guests:
                                    type: string
                                    example: "123"
                                  users:
                                    type: string
                                    example: "123"
                                  subscribers:
                                    type: integer
                                    example: 123
                              rows:
                                type: array
                                example:
                                  - rank: 1
                                    countryName: United States
                                    countryCode: US
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  - rank: 2
                                    countryName: Australia
                                    countryCode: AU
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  - rank: 3
                                    countryName: Canada
                                    countryCode: CA
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  - rank: 4
                                    countryName: United Kingdom
                                    countryCode: GB
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  - rank: 5
                                    countryName: Germany
                                    countryCode: DE
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  - rank: 6
                                    countryName: Mexico
                                    countryCode: MX
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  - rank: 7
                                    countryName: Dominican Republic
                                    countryCode: DO
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  - rank: 8
                                    countryName: Brazil
                                    countryCode: BR
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  - rank: 9
                                    countryName: Italy
                                    countryCode: IT
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  - rank: 10
                                    countryName: Denmark
                                    countryCode: DK
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  - rank: 11
                                    countryName: Others
                                    countryCode: ""
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                items:
                                  type: object
                                  properties:
                                    rank:
                                      type: integer
                                      example: 1
                                    countryName:
                                      type: string
                                      example: United States
                                    countryCode:
                                      type: string
                                      example: US
                                    viewsCount:
                                      type: object
                                      properties:
                                        total:
                                          type: integer
                                          example: 123
                                        guests:
                                          type: integer
                                          example: 123
                                        users:
                                          type: integer
                                          example: 123
                                        subscribers:
                                          type: integer
                                          example: 123
                          hasStats:
                            type: boolean
                            example: true
                      _meta:
                        type: object
                        properties:
                          _credits:
                            type: object
                            properties:
                              used:
                                type: integer
                                example: 1
                              balance:
                                type: integer
                                example: 999999814
                              note:
                                type: string
                                example: Always
                          _cache:
                            type: object
                            properties:
                              is_cached:
                                type: boolean
                                example: false
                              note:
                                type: string
                                example: Cache disabled for this endpoint
                          _rate_limits:
                            type: object
                            properties:
                              limit_minute:
                                type: integer
                                example: 1000
                              limit_day:
                                type: integer
                                example: 50000
                              remaining_minute:
                                type: integer
                                example: 998
                              remaining_day:
                                type: integer
                                example: 49959
      tags:
        - Statistics
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Subscriber Metrics (/api-reference/statistics/get-subscriber-metrics)

Get subscriber metrics including total, new, renewed, paid, and free subscriptions for a specified timeframe. `unknown_subscriptions` indicates deleted fan accounts.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/statistics/subscriber-metrics
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/statistics/subscriber-metrics:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Subscriber Metrics
      operationId: getSubscriberMetrics
      description: Get subscriber metrics including total, new, renewed, paid, and
        free subscriptions for a specified timeframe. `unknown_subscriptions`
        indicates deleted fan accounts.
      parameters:
        - in: query
          name: start_date
          description: The start date for the metrics.
          example: 2025-01-01 00:00:00
          required: true
          schema:
            type: string
            description: The start date for the metrics.
            example: 2025-01-01 00:00:00
        - in: query
          name: end_date
          description: The end date for the metrics.
          example: 2025-03-31 23:59:59
          required: true
          schema:
            type: string
            description: The end date for the metrics.
            example: 2025-03-31 23:59:59
        - in: query
          name: detailed
          description: Include paid and free fan metrics. Will slow down the response
            time, and might time out if timeframe is too large. Default =
            `false`
          example: false
          required: false
          schema:
            type: boolean
            description: Include paid and free fan metrics. Will slow down the response
              time, and might time out if timeframe is too large. Default =
              `false`
            example: false
            nullable: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    total_subscriptions: 10
                    new_subscriptions: 5
                    renewed_subscriptions: 5
                    detailed:
                      paid_subscriptions: 7
                      free_subscriptions: 2
                      unknown_subscriptions: 1
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999227
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49952
                properties:
                  data:
                    type: object
                    properties:
                      total_subscriptions:
                        type: integer
                        example: 10
                      new_subscriptions:
                        type: integer
                        example: 5
                      renewed_subscriptions:
                        type: integer
                        example: 5
                      detailed:
                        type: object
                        properties:
                          paid_subscriptions:
                            type: integer
                            example: 7
                          free_subscriptions:
                            type: integer
                            example: 2
                          unknown_subscriptions:
                            type: integer
                            example: 1
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999227
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49952
      tags:
        - Statistics
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Subscriber Statistics (/api-reference/statistics/get-subscriber-statistics)

Get subscriber and earning statistics for an account for a specified timeframe. Optionally, filter by all, renews, or new subscribers.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/subscribers/statistics
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/subscribers/statistics:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Get Subscriber Statistics
      operationId: getSubscriberStatistics
      description: Get subscriber and earning statistics for an account for a
        specified timeframe. Optionally, filter by all, renews, or new
        subscribers.
      parameters:
        - in: query
          name: start_date
          description: The start date for the period. Keep empty to calculate everything.
          example: 2025-01-01 00:00:00
          required: false
          schema:
            type: string
            description: The start date for the period. Keep empty to calculate everything.
            example: 2025-01-01 00:00:00
            nullable: true
        - in: query
          name: end_date
          description: The end date for the period. Keep empty to calculate everything.
          example: 2025-03-31 23:59:59
          required: false
          schema:
            type: string
            description: The end date for the period. Keep empty to calculate everything.
            example: 2025-03-31 23:59:59
            nullable: true
        - in: query
          name: type
          description: Filter the subscriber statistics (default = total)
          example: total
          required: false
          schema:
            type: string
            description: Filter the subscriber statistics (default = total)
            example: total
            enum:
              - total
              - renew
              - new
            nullable: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    earnings:
                      - date: 2025-01-01T00:00:00+00:00
                        count: 12.34
                    subscribes:
                      - date: 2025-01-01T00:00:00+00:00
                        count: 123
                    total: 12.34
                    delta: 12.3
                    subscribers: 123
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999287
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49994
                properties:
                  data:
                    type: object
                    properties:
                      earnings:
                        type: array
                        example:
                          - date: 2025-01-01T00:00:00+00:00
                            count: 12.34
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            count:
                              type: number
                              example: 12.34
                      subscribes:
                        type: array
                        example:
                          - date: 2025-01-01T00:00:00+00:00
                            count: 123
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            count:
                              type: integer
                              example: 123
                      total:
                        type: number
                        example: 12.34
                      delta:
                        type: number
                        example: 12.3
                      subscribers:
                        type: integer
                        example: 123
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999287
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49994
      tags:
        - Statistics
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Statistics Overview (/api-reference/statistics/statistics-overview)

Get an overview of statistics for fans, visitors, posts, or general.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/statistics/overview
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/statistics/overview:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Statistics Overview
      operationId: statisticsOverview
      description: Get an overview of statistics for fans, visitors, posts, or general.
      parameters:
        - in: query
          name: start_date
          description: The start date for the statistics. Keep empty to retrieve from the
            model's start date.
          example: 2025-01-01 00:00:00
          required: false
          schema:
            type: string
            description: The start date for the statistics. Keep empty to retrieve from the
              model's start date.
            example: 2025-01-01 00:00:00
        - in: query
          name: end_date
          description: The end date for the statistics. Keep empty to retrieve until now.
          example: 2025-03-31 23:59:59
          required: false
          schema:
            type: string
            description: The end date for the statistics. Keep empty to retrieve until now.
            example: 2025-03-31 23:59:59
        - in: query
          name: type
          description: The type of statistics to retrieve (default = empty)
          example: fans
          required: false
          schema:
            type: string
            description: The type of statistics to retrieve (default = empty)
            example: fans
            enum:
              - fans
              - visitors
              - posts
              - messages
            nullable: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    earning:
                      total: 123.45
                      gross: 123.45
                      delta: 1.6
                    posts:
                      hasStatistic: true
                      count:
                        total: 123
                        delta: 0
                      views:
                        total: 123
                        delta: -7.6
                      chartData:
                        - date: 2025-01-01T00:00:00+00:00
                          count: 123
                      earnings:
                        total: 123
                        gross: 123
                        delta: 123
                    streams:
                      hasStatistic: false
                      count:
                        total: 0m
                        delta: 0
                      views:
                        total: 0
                        delta: 0
                      chartData:
                        - date: 2025-01-01T00:00:00+00:00
                          count: 123
                      earnings:
                        total: 123
                        gross: 123
                        delta: 123
                    visitors:
                      hasStatistic: true
                      visitors:
                        total: 0
                        delta: -100
                      chartData:
                        - date: 2025-01-01T00:00:00+00:00
                          count: 123
                      earnings:
                        total: 123.45
                        gross: 123.45
                        delta: -10.9
                      subscriptions:
                        new:
                          total: 123
                          delta: -5.7
                        renew:
                          total: 123
                          delta: -17
                    massMessages:
                      hasStatistic: true
                      count:
                        total: 123
                        delta: 14.5
                      views:
                        total: 0
                        delta: 0
                      chartData:
                        - date: 2025-01-01T00:00:00+00:00
                          count: 123
                      earnings:
                        total: 123.45
                        delta: -0.1
                        gross: 123.45
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999254
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49979
                properties:
                  data:
                    type: object
                    properties:
                      earning:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 123.45
                          gross:
                            type: number
                            example: 123.45
                          delta:
                            type: number
                            example: 1.6
                      posts:
                        type: object
                        properties:
                          hasStatistic:
                            type: boolean
                            example: true
                          count:
                            type: object
                            properties:
                              total:
                                type: integer
                                example: 123
                              delta:
                                type: integer
                                example: 0
                          views:
                            type: object
                            properties:
                              total:
                                type: integer
                                example: 123
                              delta:
                                type: number
                                example: -7.6
                          chartData:
                            type: array
                            example:
                              - date: 2025-01-01T00:00:00+00:00
                                count: 123
                            items:
                              type: object
                              properties:
                                date:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                count:
                                  type: integer
                                  example: 123
                          earnings:
                            type: object
                            properties:
                              total:
                                type: integer
                                example: 123
                              gross:
                                type: integer
                                example: 123
                              delta:
                                type: integer
                                example: 123
                      streams:
                        type: object
                        properties:
                          hasStatistic:
                            type: boolean
                            example: false
                          count:
                            type: object
                            properties:
                              total:
                                type: string
                                example: 0m
                              delta:
                                type: integer
                                example: 0
                          views:
                            type: object
                            properties:
                              total:
                                type: integer
                                example: 0
                              delta:
                                type: integer
                                example: 0
                          chartData:
                            type: array
                            example:
                              - date: 2025-01-01T00:00:00+00:00
                                count: 123
                            items:
                              type: object
                              properties:
                                date:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                count:
                                  type: integer
                                  example: 123
                          earnings:
                            type: object
                            properties:
                              total:
                                type: integer
                                example: 123
                              gross:
                                type: integer
                                example: 123
                              delta:
                                type: integer
                                example: 123
                      visitors:
                        type: object
                        properties:
                          hasStatistic:
                            type: boolean
                            example: true
                          visitors:
                            type: object
                            properties:
                              total:
                                type: integer
                                example: 0
                              delta:
                                type: integer
                                example: -100
                          chartData:
                            type: array
                            example:
                              - date: 2025-01-01T00:00:00+00:00
                                count: 123
                            items:
                              type: object
                              properties:
                                date:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                count:
                                  type: integer
                                  example: 123
                          earnings:
                            type: object
                            properties:
                              total:
                                type: number
                                example: 123.45
                              gross:
                                type: number
                                example: 123.45
                              delta:
                                type: number
                                example: -10.9
                          subscriptions:
                            type: object
                            properties:
                              new:
                                type: object
                                properties:
                                  total:
                                    type: integer
                                    example: 123
                                  delta:
                                    type: number
                                    example: -5.7
                              renew:
                                type: object
                                properties:
                                  total:
                                    type: integer
                                    example: 123
                                  delta:
                                    type: integer
                                    example: -17
                      massMessages:
                        type: object
                        properties:
                          hasStatistic:
                            type: boolean
                            example: true
                          count:
                            type: object
                            properties:
                              total:
                                type: integer
                                example: 123
                              delta:
                                type: number
                                example: 14.5
                          views:
                            type: object
                            properties:
                              total:
                                type: integer
                                example: 0
                              delta:
                                type: integer
                                example: 0
                          chartData:
                            type: array
                            example:
                              - date: 2025-01-01T00:00:00+00:00
                                count: 123
                            items:
                              type: object
                              properties:
                                date:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                count:
                                  type: integer
                                  example: 123
                          earnings:
                            type: object
                            properties:
                              total:
                                type: number
                                example: 123.45
                              delta:
                                type: number
                                example: -0.1
                              gross:
                                type: number
                                example: 123.45
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999254
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49979
      tags:
        - Statistics
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Stored Shared Free Trial Links (/api-reference/stored-shared-free-trial-links/list-stored-shared-free-trial-links)

List all shared Free Trial Links from the OnlyFansAPI Cache. This is a free endpoint that does not call the OnlyFans API.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/stored/shared-trial-links
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/stored/shared-trial-links:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Stored Shared Free Trial Links
      operationId: listStoredSharedFreeTrialLinks
      description: List all shared Free Trial Links from the OnlyFansAPI Cache. This
        is a free endpoint that does not call the OnlyFans API.
      parameters:
        - in: query
          name: limit
          description: The number of shared trial links to return. Default `10`. Must be
            at least 1. Must not be greater than 1000.
          example: 10
          required: false
          schema:
            type: integer
            description: The number of shared trial links to return. Default `10`. Must be
              at least 1. Must not be greater than 1000.
            example: 10
        - in: query
          name: offset
          description: The offset used for pagination. Default `0`. Must be at least 0.
          example: 0
          required: false
          schema:
            type: integer
            description: The offset used for pagination. Default `0`. Must be at least 0.
            example: 0
        - in: query
          name: filter
          description: ""
          example: []
          required: false
          schema:
            type: object
            description: ""
            example: []
            properties: {}
        - in: query
          name: filter.search
          description: Must not be greater than 255 characters.
          example: gpmecppeleuhjalgz
          required: false
          schema:
            type: string
            description: Must not be greater than 255 characters.
            example: gpmecppeleuhjalgz
            nullable: true
        - in: query
          name: filter.tags
          description: Must not be greater than 50 characters.
          example:
            - l
          required: false
          schema:
            type: array
            description: Must not be greater than 50 characters.
            example:
              - l
            items:
              type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - id: 123
                        trialLinkName: Example shared trial link
                        url: https://onlyfans.com/username/trial/abc123
                        subscribeDays: 30
                        subscribeCounts: 0
                        claimCounts: 123
                        clicksCounts: 182
                        expiredAt: null
                        createdAt: 2025-01-01T01:01:01+00:00
                        isFinished: false
                        tags: []
                        owner:
                          id: 123
                          username: username
                          name: Model name
                          avatarThumbUrl: https://thumbs.onlyfans.com/public/files/thumbs/a123/a/aa/aaa/abc123/123/avatar.jpg
                    hasMore: false
                  _pagination:
                    next_page: null
                    notice: null
                  _meta:
                    _credits:
                      used: 0
                      balance: 10055833
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - id: 123
                            trialLinkName: Example shared trial link
                            url: https://onlyfans.com/username/trial/abc123
                            subscribeDays: 30
                            subscribeCounts: 0
                            claimCounts: 123
                            clicksCounts: 182
                            expiredAt: null
                            createdAt: 2025-01-01T01:01:01+00:00
                            isFinished: false
                            tags: []
                            owner:
                              id: 123
                              username: username
                              name: Model name
                              avatarThumbUrl: https://thumbs.onlyfans.com/public/files/thumbs/a123/a/aa/aaa/abc123/123/avatar.jpg
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            trialLinkName:
                              type: string
                              example: Example shared trial link
                            url:
                              type: string
                              example: https://onlyfans.com/username/trial/abc123
                            subscribeDays:
                              type: integer
                              example: 30
                            subscribeCounts:
                              type: integer
                              example: 0
                            claimCounts:
                              type: integer
                              example: 123
                            clicksCounts:
                              type: integer
                              example: 182
                            expiredAt:
                              type: string
                              example: null
                              nullable: true
                            createdAt:
                              type: string
                              example: 2025-01-01T01:01:01+00:00
                            isFinished:
                              type: boolean
                              example: false
                            tags:
                              type: array
                              example: []
                            owner:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                username:
                                  type: string
                                  example: username
                                name:
                                  type: string
                                  example: Model name
                                avatarThumbUrl:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/a123/a/aa/aaa/abc123/123/avatar.jpg
                      hasMore:
                        type: boolean
                        example: false
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: null
                        nullable: true
                      notice:
                        type: string
                        example: null
                        nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 10055833
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Stored Shared Free Trial Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Add Smart Link Tags (/api-reference/smart-links/add-smart-link-tags)

Add tags to a specific Smart Link. Existing tags are preserved. This is a free endpoint.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/smart-links/{smart_link_id}/tags
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/smart-links/{smart_link_id}/tags:
    parameters:
      - in: path
        name: smart_link_id
        description: The ID of the Smart Link
        example: 01JCZWQJZXQJZXQJZXQJZXQJZX
        required: true
        schema:
          type: string
    post:
      summary: Add Smart Link Tags
      operationId: addSmartLinkTags
      description: Add tags to a specific Smart Link. Existing tags are preserved.
        This is a free endpoint.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  tags:
                    - Instagram
                    - Twitter
                properties:
                  tags:
                    type: array
                    example:
                      - Instagram
                      - Twitter
                    items:
                      type: string
      tags:
        - Smart Links
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tags:
                  type: array
                  description: Array of tag names to add to the Smart Link.
                  example: '["Instagram", "Twitter"]'
                  items:
                    type: string
              required:
                - tags
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Create Smart Link (/api-reference/smart-links/create-smart-link)

Create a new Smart Link for the account. Smart Links are pooled Free Trial or Tracking links that rotate inventory automatically.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/smart-links
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/smart-links:
    post:
      summary: Create Smart Link
      operationId: createSmartLink
      description: Create a new Smart Link for the account. Smart Links are pooled
        Free Trial or Tracking links that rotate inventory automatically.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 01JCZWQJZXQJZXQJZXQJZXQJZX
                    name: Instagram Bio Link
                    link_type: free_trial
                    traffic_redirect_url: https://trk.of-traffic.com/go/01JCZWQJZXQJZXQJZXQJZXQJZX
                    free_trial_days: 7
                    clicks_count: 0
                    conversions_count: 0
                    subscribers_count: 0
                    revenue: null
                    cost:
                      inputMode: null
                      inputValue: null
                      perSub: null
                      perClick: null
                      perPromo: null
                      subscriberSourceCount: 0
                      clickSourceCount: 0
                    account:
                      id: acct_XXXXXXXX
                      display_name: Example Creator
                      username: examplecreator
                    created_at: 2025-01-15T10:30:00+00:00
                    updated_at: 2025-01-15T10:30:00+00:00
                  _meta:
                    _credits:
                      used: 0
                      balance: 999999985
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999998
                      remaining_day: 49988
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 01JCZWQJZXQJZXQJZXQJZXQJZX
                      name:
                        type: string
                        example: Instagram Bio Link
                      link_type:
                        type: string
                        example: free_trial
                      traffic_redirect_url:
                        type: string
                        example: https://trk.of-traffic.com/go/01JCZWQJZXQJZXQJZXQJZXQJZX
                      free_trial_days:
                        type: integer
                        example: 7
                      clicks_count:
                        type: integer
                        example: 0
                      conversions_count:
                        type: integer
                        example: 0
                      subscribers_count:
                        type: integer
                        example: 0
                      revenue:
                        type: string
                        example: null
                        nullable: true
                      cost:
                        type: object
                        properties:
                          inputMode:
                            type: string
                            example: null
                            nullable: true
                          inputValue:
                            type: string
                            example: null
                            nullable: true
                          perSub:
                            type: string
                            example: null
                            nullable: true
                          perClick:
                            type: string
                            example: null
                            nullable: true
                          perPromo:
                            type: string
                            example: null
                            nullable: true
                          subscriberSourceCount:
                            type: integer
                            example: 0
                          clickSourceCount:
                            type: integer
                            example: 0
                      account:
                        type: object
                        properties:
                          id:
                            type: string
                            example: acct_XXXXXXXX
                          display_name:
                            type: string
                            example: Example Creator
                          username:
                            type: string
                            example: examplecreator
                      created_at:
                        type: string
                        example: 2025-01-15T10:30:00+00:00
                      updated_at:
                        type: string
                        example: 2025-01-15T10:30:00+00:00
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 999999985
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999998
                          remaining_day:
                            type: integer
                            example: 49988
      tags:
        - Smart Links
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                account_id:
                  type: string
                  description: The prefixed ID of the account to create the Smart Link for
                  example: acct_XXXXXXXX
                name:
                  type: string
                  description: The name of the Smart Link
                  example: Instagram Bio Link
                link_type:
                  type: string
                  description: The type of Smart Link to create
                  example: free_trial
                  enum:
                    - free_trial
                    - tracking_link
                free_trial_days:
                  type: integer
                  description: The number of free trial days (required if `link_type` is
                    `free_trial`). Must be between 1 and 360.
                  example: 7
              required:
                - account_id
                - name
                - link_type
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Delete Smart Link (/api-reference/smart-links/delete-smart-link)

Delete a Smart Link by its ID

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/smart-links/{smart_link_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/smart-links/{smart_link_id}:
    parameters:
      - in: path
        name: smart_link_id
        description: The ID of the Smart Link
        example: 01JCZWQJZXQJZXQJZXQJZXQJZX
        required: true
        schema:
          type: string
    delete:
      summary: Delete Smart Link
      operationId: deleteSmartLink
      description: Delete a Smart Link by its ID
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 0
                      balance: 999999986
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999997
                      remaining_day: 49990
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 999999986
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999997
                          remaining_day:
                            type: integer
                            example: 49990
      tags:
        - Smart Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Smart Link Cohort ARPS (/api-reference/smart-links/get-smart-link-cohort-arps)

Get per-link time-to-profit cohort ARPS windows for a specific Smart Link

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/smart-links/{smart_link_id}/cohort-arps
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/smart-links/{smart_link_id}/cohort-arps:
    parameters:
      - in: path
        name: smart_link_id
        description: The ID of the smart link.
        example: ipsa
        required: true
        schema:
          type: string
    get:
      summary: Get Smart Link Cohort ARPS
      operationId: getSmartLinkCohortARPS
      description: Get per-link time-to-profit cohort ARPS windows for a specific Smart Link
      parameters:
        - in: query
          name: acquisition_start
          description: Optional acquisition range start date
          example: 2026-01-01T00:00:00Z
          required: false
          schema:
            type: string
            description: Optional acquisition range start date
            example: 2026-01-01T00:00:00Z
        - in: query
          name: acquisition_end
          description: Optional acquisition range end date
          example: 2026-01-31T23:59:59Z
          required: false
          schema:
            type: string
            description: Optional acquisition range end date
            example: 2026-01-31T23:59:59Z
        - in: query
          name: revenue_basis
          description: Revenue basis. Defaults to `net`.
          example: net
          required: false
          schema:
            type: string
            description: Revenue basis. Defaults to `net`.
            example: net
            enum:
              - net
              - gross
      responses:
        "401":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  error: Unauthorized. Go to https://app.onlyfansapi.com/api-keys to get your API
                    key.
                properties:
                  error:
                    type: string
                    example: Unauthorized. Go to https://app.onlyfansapi.com/api-keys to get your
                      API key.
      tags:
        - Smart Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Smart Link Stats (/api-reference/smart-links/get-smart-link-stats)

Get dashboard-style summary plus daily and monthly metrics for a specific Smart Link on the current team

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/smart-links/{smart_link_id}/stats
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/smart-links/{smart_link_id}/stats:
    parameters:
      - in: path
        name: smart_link_id
        description: The ID of the smart link.
        example: ut
        required: true
        schema:
          type: string
    get:
      summary: Get Smart Link Stats
      operationId: getSmartLinkStats
      description: Get dashboard-style summary plus daily and monthly metrics for a
        specific Smart Link on the current team
      parameters:
        - in: query
          name: date_start
          description: Optional stats range start date
          example: 2026-01-01T00:00:00Z
          required: false
          schema:
            type: string
            description: Optional stats range start date
            example: 2026-01-01T00:00:00Z
        - in: query
          name: date_end
          description: Optional stats range end date
          example: 2026-01-31T23:59:59Z
          required: false
          schema:
            type: string
            description: Optional stats range end date
            example: 2026-01-31T23:59:59Z
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    summary:
                      clicks_total: 150
                      subs_total: 45
                      revenue_total: 1250
                      spenders_total: 20
                    daily_metrics:
                      - timestamp: 2026-01-30
                        clicks: 9
                        subs: 2
                        revenue: 33
                        spenders: 1
                      - timestamp: 2026-01-31
                        clicks: 16
                        subs: 5
                        revenue: 95
                        spenders: 2
                    monthly_metrics:
                      - timestamp: 2026-01-01
                        clicks: 150
                        subs: 45
                        revenue: 1250
                        spenders: 20
                  _meta:
                    _credits:
                      used: 0
                      balance: 999999
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                properties:
                  data:
                    type: object
                    properties:
                      summary:
                        type: object
                        properties:
                          clicks_total:
                            type: integer
                            example: 150
                          subs_total:
                            type: integer
                            example: 45
                          revenue_total:
                            type: integer
                            example: 1250
                          spenders_total:
                            type: integer
                            example: 20
                      daily_metrics:
                        type: array
                        example:
                          - timestamp: 2026-01-30
                            clicks: 9
                            subs: 2
                            revenue: 33
                            spenders: 1
                          - timestamp: 2026-01-31
                            clicks: 16
                            subs: 5
                            revenue: 95
                            spenders: 2
                        items:
                          type: object
                          properties:
                            timestamp:
                              type: string
                              example: 2026-01-30
                            clicks:
                              type: integer
                              example: 9
                            subs:
                              type: integer
                              example: 2
                            revenue:
                              type: integer
                              example: 33
                            spenders:
                              type: integer
                              example: 1
                      monthly_metrics:
                        type: array
                        example:
                          - timestamp: 2026-01-01
                            clicks: 150
                            subs: 45
                            revenue: 1250
                            spenders: 20
                        items:
                          type: object
                          properties:
                            timestamp:
                              type: string
                              example: 2026-01-01
                            clicks:
                              type: integer
                              example: 150
                            subs:
                              type: integer
                              example: 45
                            revenue:
                              type: integer
                              example: 1250
                            spenders:
                              type: integer
                              example: 20
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 999999
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
      tags:
        - Smart Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Smart Link (/api-reference/smart-links/get-smart-link)

Get a specific Smart Link by its ID

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/smart-links/{smart_link_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/smart-links/{smart_link_id}:
    parameters:
      - in: path
        name: smart_link_id
        description: The ID of the Smart Link
        example: 01JCZWQJZXQJZXQJZXQJZXQJZX
        required: true
        schema:
          type: string
    get:
      summary: Get Smart Link
      operationId: getSmartLink
      description: Get a specific Smart Link by its ID
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 01JCZWQJZXQJZXQJZXQJZXQJZX
                    name: Instagram Bio Link
                    link_type: free_trial
                    traffic_redirect_url: https://trk.of-traffic.com/go/01JCZWQJZXQJZXQJZXQJZXQJZX
                    free_trial_days: 7
                    clicks_count: 150
                    conversions_count: 45
                    subscribers_count: 30
                    revenue: "1250.00"
                    cost:
                      inputMode: null
                      inputValue: null
                      perSub: null
                      perClick: null
                      perPromo: null
                      subscriberSourceCount: 30
                      clickSourceCount: 150
                    account:
                      id: acct_XXXXXXXX
                      display_name: Example Creator
                      username: examplecreator
                    created_at: 2025-01-15T10:30:00+00:00
                    updated_at: 2025-01-15T10:30:00+00:00
                  _meta:
                    _credits:
                      used: 0
                      balance: 999999985
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999998
                      remaining_day: 49988
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 01JCZWQJZXQJZXQJZXQJZXQJZX
                      name:
                        type: string
                        example: Instagram Bio Link
                      link_type:
                        type: string
                        example: free_trial
                      traffic_redirect_url:
                        type: string
                        example: https://trk.of-traffic.com/go/01JCZWQJZXQJZXQJZXQJZXQJZX
                      free_trial_days:
                        type: integer
                        example: 7
                      clicks_count:
                        type: integer
                        example: 150
                      conversions_count:
                        type: integer
                        example: 45
                      subscribers_count:
                        type: integer
                        example: 30
                      revenue:
                        type: string
                        example: "1250.00"
                      cost:
                        type: object
                        properties:
                          inputMode:
                            type: string
                            example: null
                            nullable: true
                          inputValue:
                            type: string
                            example: null
                            nullable: true
                          perSub:
                            type: string
                            example: null
                            nullable: true
                          perClick:
                            type: string
                            example: null
                            nullable: true
                          perPromo:
                            type: string
                            example: null
                            nullable: true
                          subscriberSourceCount:
                            type: integer
                            example: 30
                          clickSourceCount:
                            type: integer
                            example: 150
                      account:
                        type: object
                        properties:
                          id:
                            type: string
                            example: acct_XXXXXXXX
                          display_name:
                            type: string
                            example: Example Creator
                          username:
                            type: string
                            example: examplecreator
                      created_at:
                        type: string
                        example: 2025-01-15T10:30:00+00:00
                      updated_at:
                        type: string
                        example: 2025-01-15T10:30:00+00:00
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 999999985
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999998
                          remaining_day:
                            type: integer
                            example: 49988
      tags:
        - Smart Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Smart Link Clicks (/api-reference/smart-links/list-smart-link-clicks)

Query smart link clicks in a date range with optional bot/duplicate filtering

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/smart-links/{smart_link_id}/clicks
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/smart-links/{smart_link_id}/clicks:
    parameters:
      - in: path
        name: smart_link_id
        description: The ID of the smart link.
        example: veniam
        required: true
        schema:
          type: string
    get:
      summary: List Smart Link Clicks
      operationId: listSmartLinkClicks
      description: Query smart link clicks in a date range with optional bot/duplicate
        filtering
      parameters:
        - in: query
          name: date_start
          description: Optional report range start date
          example: 2026-01-01T00:00:00Z
          required: false
          schema:
            type: string
            description: Optional report range start date
            example: 2026-01-01T00:00:00Z
        - in: query
          name: date_end
          description: Optional report range end date
          example: 2026-01-07T23:59:59Z
          required: false
          schema:
            type: string
            description: Optional report range end date
            example: 2026-01-07T23:59:59Z
        - in: query
          name: limit
          description: Rows per page. Default `100`
          example: 100
          required: false
          schema:
            type: integer
            description: Rows per page. Default `100`
            example: 100
        - in: query
          name: offset
          description: Offset for pagination. Default `0`
          example: 0
          required: false
          schema:
            type: integer
            description: Offset for pagination. Default `0`
            example: 0
        - in: query
          name: include_bots
          description: Include clicks marked as bots. Default `true`
          example: true
          required: false
          schema:
            type: boolean
            description: Include clicks marked as bots. Default `true`
            example: true
        - in: query
          name: include_duplicates
          description: Include duplicate clicks. Default `true`
          example: true
          required: false
          schema:
            type: boolean
            description: Include duplicate clicks. Default `true`
            example: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    summary:
                      clicks_total: 25
                    chart:
                      - timestamp: 2026-01-30
                        clicks: 10
                      - timestamp: 2026-01-31
                        clicks: 15
                    rows:
                      - id: 01JTESTCLICK000000000000001
                        created_at: 2026-01-31T21:45:00+00:00
                        referrer: example.com
                        ip_address: 192.168.1.10
                        user_agent: Mozilla/5.0
                        browser_device_type: Desktop
                        browser_name: Chrome
                        browser_family: Chrome
                        browser_platform: macOS
                        is_bot: false
                        is_duplicate: false
                        country_code: US
                        external_click_id: ext_123
                        gross_clicks: 1
                        fbclid: null
                        gclid: google-click-id
                        ttclid: tiktok-click-id
                        aff_s1: campaign-a
                        aff_s2: null
                        aff_s3: null
                        aff_s4: null
                        aff_s5: null
                        utm_source: google
                        utm_medium: cpc
                        utm_campaign: winter
                        utm_content: creative-a
                        utm_term: fans
                    filters:
                      date_start: 2026-01-25T00:00:00+00:00
                      date_end: 2026-01-31T23:59:59+00:00
                      limit: 100
                      offset: 0
                      include_bots: true
                      include_duplicates: true
                  _meta:
                    _credits:
                      used: 0
                      balance: 999999
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                properties:
                  data:
                    type: object
                    properties:
                      summary:
                        type: object
                        properties:
                          clicks_total:
                            type: integer
                            example: 25
                      chart:
                        type: array
                        example:
                          - timestamp: 2026-01-30
                            clicks: 10
                          - timestamp: 2026-01-31
                            clicks: 15
                        items:
                          type: object
                          properties:
                            timestamp:
                              type: string
                              example: 2026-01-30
                            clicks:
                              type: integer
                              example: 10
                      rows:
                        type: array
                        example:
                          - id: 01JTESTCLICK000000000000001
                            created_at: 2026-01-31T21:45:00+00:00
                            referrer: example.com
                            ip_address: 192.168.1.10
                            user_agent: Mozilla/5.0
                            browser_device_type: Desktop
                            browser_name: Chrome
                            browser_family: Chrome
                            browser_platform: macOS
                            is_bot: false
                            is_duplicate: false
                            country_code: US
                            external_click_id: ext_123
                            gross_clicks: 1
                            fbclid: null
                            gclid: google-click-id
                            ttclid: tiktok-click-id
                            aff_s1: campaign-a
                            aff_s2: null
                            aff_s3: null
                            aff_s4: null
                            aff_s5: null
                            utm_source: google
                            utm_medium: cpc
                            utm_campaign: winter
                            utm_content: creative-a
                            utm_term: fans
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 01JTESTCLICK000000000000001
                            created_at:
                              type: string
                              example: 2026-01-31T21:45:00+00:00
                            referrer:
                              type: string
                              example: example.com
                            ip_address:
                              type: string
                              example: 192.168.1.10
                            user_agent:
                              type: string
                              example: Mozilla/5.0
                            browser_device_type:
                              type: string
                              example: Desktop
                            browser_name:
                              type: string
                              example: Chrome
                            browser_family:
                              type: string
                              example: Chrome
                            browser_platform:
                              type: string
                              example: macOS
                            is_bot:
                              type: boolean
                              example: false
                            is_duplicate:
                              type: boolean
                              example: false
                            country_code:
                              type: string
                              example: US
                            external_click_id:
                              type: string
                              example: ext_123
                            gross_clicks:
                              type: integer
                              example: 1
                            fbclid:
                              type: string
                              example: null
                              nullable: true
                            gclid:
                              type: string
                              example: google-click-id
                            ttclid:
                              type: string
                              example: tiktok-click-id
                            aff_s1:
                              type: string
                              example: campaign-a
                            aff_s2:
                              type: string
                              example: null
                              nullable: true
                            aff_s3:
                              type: string
                              example: null
                              nullable: true
                            aff_s4:
                              type: string
                              example: null
                              nullable: true
                            aff_s5:
                              type: string
                              example: null
                              nullable: true
                            utm_source:
                              type: string
                              example: google
                            utm_medium:
                              type: string
                              example: cpc
                            utm_campaign:
                              type: string
                              example: winter
                            utm_content:
                              type: string
                              example: creative-a
                            utm_term:
                              type: string
                              example: fans
                      filters:
                        type: object
                        properties:
                          date_start:
                            type: string
                            example: 2026-01-25T00:00:00+00:00
                          date_end:
                            type: string
                            example: 2026-01-31T23:59:59+00:00
                          limit:
                            type: integer
                            example: 100
                          offset:
                            type: integer
                            example: 0
                          include_bots:
                            type: boolean
                            example: true
                          include_duplicates:
                            type: boolean
                            example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 999999
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
      tags:
        - Smart Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Smart Link Conversions (/api-reference/smart-links/list-smart-link-conversions)

Query smart link conversions in a date range with optional bot/duplicate and conversion type filtering

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/smart-links/{smart_link_id}/conversions
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/smart-links/{smart_link_id}/conversions:
    parameters:
      - in: path
        name: smart_link_id
        description: The ID of the smart link.
        example: eveniet
        required: true
        schema:
          type: string
    get:
      summary: List Smart Link Conversions
      operationId: listSmartLinkConversions
      description: Query smart link conversions in a date range with optional
        bot/duplicate and conversion type filtering
      parameters:
        - in: query
          name: date_start
          description: Optional report range start date
          example: 2026-01-01T00:00:00Z
          required: false
          schema:
            type: string
            description: Optional report range start date
            example: 2026-01-01T00:00:00Z
        - in: query
          name: date_end
          description: Optional report range end date
          example: 2026-01-07T23:59:59Z
          required: false
          schema:
            type: string
            description: Optional report range end date
            example: 2026-01-07T23:59:59Z
        - in: query
          name: limit
          description: Rows per page. Default `100`
          example: 100
          required: false
          schema:
            type: integer
            description: Rows per page. Default `100`
            example: 100
        - in: query
          name: offset
          description: Offset for pagination. Default `0`
          example: 0
          required: false
          schema:
            type: integer
            description: Offset for pagination. Default `0`
            example: 0
        - in: query
          name: include_bots
          description: Include conversions from clicks marked as bots. Default `true`
          example: true
          required: false
          schema:
            type: boolean
            description: Include conversions from clicks marked as bots. Default `true`
            example: true
        - in: query
          name: include_duplicates
          description: Include conversions from duplicate clicks. Default `true`
          example: true
          required: false
          schema:
            type: boolean
            description: Include conversions from duplicate clicks. Default `true`
            example: true
        - in: query
          name: conversion_type
          description: Optional conversion type filter
          example: new_transaction
          required: false
          schema:
            type: string
            description: Optional conversion type filter
            example: new_transaction
            enum:
              - new_subscriber
              - new_transaction
              - message_received
              - fan_sent_3_messages
        - in: query
          name: onlyfans_user_id
          description: Optional - Search for conversions by OnlyFans User ID
          example: "1234567"
          required: false
          schema:
            type: string
            description: Optional - Search for conversions by OnlyFans User ID
            example: "1234567"
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    summary:
                      conversions_total: 6
                      subscribers_total: 3
                      revenue_total: 240.5
                    chart:
                      - timestamp: 2026-01-30
                        conversions: 2
                      - timestamp: 2026-01-31
                        conversions: 4
                    rows:
                      - id: 01JTESTCONV0000000000000001
                        conversion_type: new_transaction
                        amount_gross: 120.25
                        amount_net: 100
                        conversion_at: 2026-01-31T22:15:00+00:00
                        fan_onlyfans_id: "123456789"
                        fan:
                          onlyfans_id: "123456789"
                          username: demo_fan
                          name: Demo Fan
                          avatar_url: https://cdn.example.com/avatar.jpg
                          onlyfans_url: https://onlyfans.com/demo_fan
                        click:
                          id: 01JTESTCLICK000000000000001
                          created_at: 2026-01-31T21:45:00+00:00
                          referrer: example.com
                          ip_address: 192.168.1.10
                          user_agent: Mozilla/5.0
                          browser_device_type: Desktop
                          browser_name: Chrome
                          browser_family: Chrome
                          browser_platform: macOS
                          is_bot: false
                          is_duplicate: false
                          country_code: US
                          external_click_id: ext_123
                          gross_clicks: 1
                          fbclid: null
                          gclid: google-click-id
                          ttclid: tiktok-click-id
                          aff_s1: campaign-a
                          aff_s2: null
                          aff_s3: null
                          aff_s4: null
                          aff_s5: null
                          utm_source: google
                          utm_medium: cpc
                          utm_campaign: winter
                          utm_content: creative-a
                          utm_term: fans
                    filters:
                      date_start: 2026-01-25T00:00:00+00:00
                      date_end: 2026-01-31T23:59:59+00:00
                      limit: 100
                      offset: 0
                      include_bots: true
                      include_duplicates: true
                      conversion_type: new_transaction
                  _meta:
                    _credits:
                      used: 0
                      balance: 999999
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                properties:
                  data:
                    type: object
                    properties:
                      summary:
                        type: object
                        properties:
                          conversions_total:
                            type: integer
                            example: 6
                          subscribers_total:
                            type: integer
                            example: 3
                          revenue_total:
                            type: number
                            example: 240.5
                      chart:
                        type: array
                        example:
                          - timestamp: 2026-01-30
                            conversions: 2
                          - timestamp: 2026-01-31
                            conversions: 4
                        items:
                          type: object
                          properties:
                            timestamp:
                              type: string
                              example: 2026-01-30
                            conversions:
                              type: integer
                              example: 2
                      rows:
                        type: array
                        example:
                          - id: 01JTESTCONV0000000000000001
                            conversion_type: new_transaction
                            amount_gross: 120.25
                            amount_net: 100
                            conversion_at: 2026-01-31T22:15:00+00:00
                            fan_onlyfans_id: "123456789"
                            fan:
                              onlyfans_id: "123456789"
                              username: demo_fan
                              name: Demo Fan
                              avatar_url: https://cdn.example.com/avatar.jpg
                              onlyfans_url: https://onlyfans.com/demo_fan
                            click:
                              id: 01JTESTCLICK000000000000001
                              created_at: 2026-01-31T21:45:00+00:00
                              referrer: example.com
                              ip_address: 192.168.1.10
                              user_agent: Mozilla/5.0
                              browser_device_type: Desktop
                              browser_name: Chrome
                              browser_family: Chrome
                              browser_platform: macOS
                              is_bot: false
                              is_duplicate: false
                              country_code: US
                              external_click_id: ext_123
                              gross_clicks: 1
                              fbclid: null
                              gclid: google-click-id
                              ttclid: tiktok-click-id
                              aff_s1: campaign-a
                              aff_s2: null
                              aff_s3: null
                              aff_s4: null
                              aff_s5: null
                              utm_source: google
                              utm_medium: cpc
                              utm_campaign: winter
                              utm_content: creative-a
                              utm_term: fans
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 01JTESTCONV0000000000000001
                            conversion_type:
                              type: string
                              example: new_transaction
                            amount_gross:
                              type: number
                              example: 120.25
                            amount_net:
                              type: number
                              example: 100
                            conversion_at:
                              type: string
                              example: 2026-01-31T22:15:00+00:00
                            fan_onlyfans_id:
                              type: string
                              example: "123456789"
                            fan:
                              type: object
                              properties:
                                onlyfans_id:
                                  type: string
                                  example: "123456789"
                                username:
                                  type: string
                                  example: demo_fan
                                name:
                                  type: string
                                  example: Demo Fan
                                avatar_url:
                                  type: string
                                  example: https://cdn.example.com/avatar.jpg
                                onlyfans_url:
                                  type: string
                                  example: https://onlyfans.com/demo_fan
                            click:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: 01JTESTCLICK000000000000001
                                created_at:
                                  type: string
                                  example: 2026-01-31T21:45:00+00:00
                                referrer:
                                  type: string
                                  example: example.com
                                ip_address:
                                  type: string
                                  example: 192.168.1.10
                                user_agent:
                                  type: string
                                  example: Mozilla/5.0
                                browser_device_type:
                                  type: string
                                  example: Desktop
                                browser_name:
                                  type: string
                                  example: Chrome
                                browser_family:
                                  type: string
                                  example: Chrome
                                browser_platform:
                                  type: string
                                  example: macOS
                                is_bot:
                                  type: boolean
                                  example: false
                                is_duplicate:
                                  type: boolean
                                  example: false
                                country_code:
                                  type: string
                                  example: US
                                external_click_id:
                                  type: string
                                  example: ext_123
                                gross_clicks:
                                  type: integer
                                  example: 1
                                fbclid:
                                  type: string
                                  example: null
                                  nullable: true
                                gclid:
                                  type: string
                                  example: google-click-id
                                ttclid:
                                  type: string
                                  example: tiktok-click-id
                                aff_s1:
                                  type: string
                                  example: campaign-a
                                aff_s2:
                                  type: string
                                  example: null
                                  nullable: true
                                aff_s3:
                                  type: string
                                  example: null
                                  nullable: true
                                aff_s4:
                                  type: string
                                  example: null
                                  nullable: true
                                aff_s5:
                                  type: string
                                  example: null
                                  nullable: true
                                utm_source:
                                  type: string
                                  example: google
                                utm_medium:
                                  type: string
                                  example: cpc
                                utm_campaign:
                                  type: string
                                  example: winter
                                utm_content:
                                  type: string
                                  example: creative-a
                                utm_term:
                                  type: string
                                  example: fans
                      filters:
                        type: object
                        properties:
                          date_start:
                            type: string
                            example: 2026-01-25T00:00:00+00:00
                          date_end:
                            type: string
                            example: 2026-01-31T23:59:59+00:00
                          limit:
                            type: integer
                            example: 100
                          offset:
                            type: integer
                            example: 0
                          include_bots:
                            type: boolean
                            example: true
                          include_duplicates:
                            type: boolean
                            example: true
                          conversion_type:
                            type: string
                            example: new_transaction
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 999999
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
      tags:
        - Smart Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Smart Link Fans (/api-reference/smart-links/list-smart-link-fans)

Query attributed Smart Link fans with aggregate fan metrics and subscriber attribution metadata

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/smart-links/{smart_link_id}/fans
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/smart-links/{smart_link_id}/fans:
    parameters:
      - in: path
        name: smart_link_id
        description: The ID of the smart link.
        example: accusantium
        required: true
        schema:
          type: string
    get:
      summary: List Smart Link Fans
      operationId: listSmartLinkFans
      description: Query attributed Smart Link fans with aggregate fan metrics and
        subscriber attribution metadata
      parameters:
        - in: query
          name: limit
          description: Rows per page. Default `100`
          example: 100
          required: false
          schema:
            type: integer
            description: Rows per page. Default `100`
            example: 100
        - in: query
          name: offset
          description: Offset for pagination. Default `0`
          example: 0
          required: false
          schema:
            type: integer
            description: Offset for pagination. Default `0`
            example: 0
        - in: query
          name: sort
          description: Optional sort field. Default `-revenue_net`
          example: -revenue_net
          required: false
          schema:
            type: string
            description: Optional sort field. Default `-revenue_net`
            example: -revenue_net
            enum:
              - revenue_net
              - -revenue_net
              - tips_net
              - -tips_net
              - messages_sent_by_fan
              - -messages_sent_by_fan
              - converted_at
              - -converted_at
        - in: query
          name: has_messages
          description: Optional - Filter to fans with or without fan-sent messages
          example: true
          required: false
          schema:
            type: boolean
            description: Optional - Filter to fans with or without fan-sent messages
            example: true
        - in: query
          name: min_messages_sent_by_fan
          description: Optional minimum number of messages sent by fan
          example: 3
          required: false
          schema:
            type: integer
            description: Optional minimum number of messages sent by fan
            example: 3
        - in: query
          name: min_revenue_net
          description: Optional minimum net revenue
          example: 25
          required: false
          schema:
            type: number
            description: Optional minimum net revenue
            example: 25
        - in: query
          name: min_tips_net
          description: Optional minimum net tips
          example: 10
          required: false
          schema:
            type: number
            description: Optional minimum net tips
            example: 10
        - in: query
          name: previously_subscribed
          description: Optional - Filter to returning subscribers (fans previously
            subscribed before this subscription)
          example: true
          required: false
          schema:
            type: boolean
            description: Optional - Filter to returning subscribers (fans previously
              subscribed before this subscription)
            example: true
        - in: query
          name: subscribed_using_promo
          description: Optional - Filter to fans who subscribed via a promotion/offer
          example: true
          required: false
          schema:
            type: boolean
            description: Optional - Filter to fans who subscribed via a promotion/offer
            example: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    summary:
                      fans_total: 3
                      revenue_net_total: 145
                      tips_net_total: 45
                      fans_with_3_plus_messages_total: 1
                    rows:
                      - fan_id: 101
                        onlyfans_id: "100000001"
                        username: demo_fan_a
                        name: Demo Fan A
                        avatar_url: https://cdn.example.com/avatar-a.jpg
                        revenue_net: 90
                        tips_net: 30
                        messages_sent_by_fan: 4
                        converted_at: 2026-01-12T12:00:00+00:00
                        conversion_id: 9001
                        click_id: 01JTESTCLICK000000000000001
                        external_click_id: ext-a
                        subscription_insights:
                          has_subscription_data: true
                          previously_subscribed: true
                          subscribed_using_promo: true
                          current_subscription_from_smart_link: true
                          current_subscription:
                            type: promo
                            action: return
                            price: 0
                            regular_price: 15
                            is_free: true
                      - fan_id: 102
                        onlyfans_id: "100000002"
                        username: demo_fan_b
                        name: Demo Fan B
                        avatar_url: https://cdn.example.com/avatar-b.jpg
                        revenue_net: 40
                        tips_net: 10
                        messages_sent_by_fan: 2
                        converted_at: 2026-01-10T10:00:00+00:00
                        conversion_id: 9002
                        click_id: 01JTESTCLICK000000000000002
                        external_click_id: ext-b
                        subscription_insights:
                          has_subscription_data: true
                          previously_subscribed: false
                          subscribed_using_promo: false
                          current_subscription_from_smart_link: true
                          current_subscription:
                            type: regular
                            action: subscribe
                            price: 15
                            regular_price: 15
                            is_free: false
                      - fan_id: 103
                        onlyfans_id: "100000003"
                        username: demo_fan_c
                        name: Demo Fan C
                        avatar_url: null
                        revenue_net: 15
                        tips_net: 5
                        messages_sent_by_fan: 0
                        converted_at: null
                        conversion_id: null
                        click_id: null
                        external_click_id: null
                        subscription_insights:
                          has_subscription_data: false
                          previously_subscribed: null
                          subscribed_using_promo: null
                          current_subscription_from_smart_link: null
                          current_subscription:
                            type: null
                            action: null
                            price: null
                            regular_price: null
                            is_free: null
                    filters:
                      limit: 100
                      offset: 0
                      sort: -revenue_net
                      has_messages: null
                      min_messages_sent_by_fan: null
                      min_revenue_net: null
                      min_tips_net: null
                      previously_subscribed: null
                      subscribed_using_promo: null
                  _meta:
                    _credits:
                      used: 0
                      balance: 999999
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                properties:
                  data:
                    type: object
                    properties:
                      summary:
                        type: object
                        properties:
                          fans_total:
                            type: integer
                            example: 3
                          revenue_net_total:
                            type: integer
                            example: 145
                          tips_net_total:
                            type: integer
                            example: 45
                          fans_with_3_plus_messages_total:
                            type: integer
                            example: 1
                      rows:
                        type: array
                        example:
                          - fan_id: 101
                            onlyfans_id: "100000001"
                            username: demo_fan_a
                            name: Demo Fan A
                            avatar_url: https://cdn.example.com/avatar-a.jpg
                            revenue_net: 90
                            tips_net: 30
                            messages_sent_by_fan: 4
                            converted_at: 2026-01-12T12:00:00+00:00
                            conversion_id: 9001
                            click_id: 01JTESTCLICK000000000000001
                            external_click_id: ext-a
                            subscription_insights:
                              has_subscription_data: true
                              previously_subscribed: true
                              subscribed_using_promo: true
                              current_subscription_from_smart_link: true
                              current_subscription:
                                type: promo
                                action: return
                                price: 0
                                regular_price: 15
                                is_free: true
                          - fan_id: 102
                            onlyfans_id: "100000002"
                            username: demo_fan_b
                            name: Demo Fan B
                            avatar_url: https://cdn.example.com/avatar-b.jpg
                            revenue_net: 40
                            tips_net: 10
                            messages_sent_by_fan: 2
                            converted_at: 2026-01-10T10:00:00+00:00
                            conversion_id: 9002
                            click_id: 01JTESTCLICK000000000000002
                            external_click_id: ext-b
                            subscription_insights:
                              has_subscription_data: true
                              previously_subscribed: false
                              subscribed_using_promo: false
                              current_subscription_from_smart_link: true
                              current_subscription:
                                type: regular
                                action: subscribe
                                price: 15
                                regular_price: 15
                                is_free: false
                          - fan_id: 103
                            onlyfans_id: "100000003"
                            username: demo_fan_c
                            name: Demo Fan C
                            avatar_url: null
                            revenue_net: 15
                            tips_net: 5
                            messages_sent_by_fan: 0
                            converted_at: null
                            conversion_id: null
                            click_id: null
                            external_click_id: null
                            subscription_insights:
                              has_subscription_data: false
                              previously_subscribed: null
                              subscribed_using_promo: null
                              current_subscription_from_smart_link: null
                              current_subscription:
                                type: null
                                action: null
                                price: null
                                regular_price: null
                                is_free: null
                        items:
                          type: object
                          properties:
                            fan_id:
                              type: integer
                              example: 101
                            onlyfans_id:
                              type: string
                              example: "100000001"
                            username:
                              type: string
                              example: demo_fan_a
                            name:
                              type: string
                              example: Demo Fan A
                            avatar_url:
                              type: string
                              example: https://cdn.example.com/avatar-a.jpg
                            revenue_net:
                              type: integer
                              example: 90
                            tips_net:
                              type: integer
                              example: 30
                            messages_sent_by_fan:
                              type: integer
                              example: 4
                            converted_at:
                              type: string
                              example: 2026-01-12T12:00:00+00:00
                            conversion_id:
                              type: integer
                              example: 9001
                            click_id:
                              type: string
                              example: 01JTESTCLICK000000000000001
                            external_click_id:
                              type: string
                              example: ext-a
                            subscription_insights:
                              type: object
                              properties:
                                has_subscription_data:
                                  type: boolean
                                  example: true
                                previously_subscribed:
                                  type: boolean
                                  example: true
                                subscribed_using_promo:
                                  type: boolean
                                  example: true
                                current_subscription_from_smart_link:
                                  type: boolean
                                  example: true
                                current_subscription:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                      example: promo
                                    action:
                                      type: string
                                      example: return
                                    price:
                                      type: integer
                                      example: 0
                                    regular_price:
                                      type: integer
                                      example: 15
                                    is_free:
                                      type: boolean
                                      example: true
                      filters:
                        type: object
                        properties:
                          limit:
                            type: integer
                            example: 100
                          offset:
                            type: integer
                            example: 0
                          sort:
                            type: string
                            example: -revenue_net
                          has_messages:
                            type: string
                            example: null
                            nullable: true
                          min_messages_sent_by_fan:
                            type: string
                            example: null
                            nullable: true
                          min_revenue_net:
                            type: string
                            example: null
                            nullable: true
                          min_tips_net:
                            type: string
                            example: null
                            nullable: true
                          previously_subscribed:
                            type: string
                            example: null
                            nullable: true
                          subscribed_using_promo:
                            type: string
                            example: null
                            nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 999999
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
      tags:
        - Smart Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Smart Link Spenders (/api-reference/smart-links/list-smart-link-spenders)

Compatibility endpoint returning fans with attributed spend through a Smart Link

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/smart-links/{smart_link_id}/spenders
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/smart-links/{smart_link_id}/spenders:
    parameters:
      - in: path
        name: smart_link_id
        description: The ID of the smart link.
        example: aut
        required: true
        schema:
          type: string
    get:
      summary: List Smart Link Spenders
      operationId: listSmartLinkSpenders
      description: Compatibility endpoint returning fans with attributed spend through
        a Smart Link
      parameters:
        - in: query
          name: limit
          description: The number of spenders to return per page. Default `50`
          example: 50
          required: false
          schema:
            type: integer
            description: The number of spenders to return per page. Default `50`
            example: 50
        - in: query
          name: offset
          description: The offset used for pagination. Default `0`
          example: 0
          required: false
          schema:
            type: integer
            description: The offset used for pagination. Default `0`
            example: 0
        - in: query
          name: minSpend
          description: Minimal spend of a fan. Default `1`
          example: 1
          required: false
          schema:
            type: number
            description: Minimal spend of a fan. Default `1`
            example: 1
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - onlyfans_id: "100000001"
                      username: demo_spender_a
                      revenue:
                        total: 109.88
                        calculated_at: 2026-01-31T12:00:00+00:00
                    - onlyfans_id: "100000002"
                      username: demo_spender_b
                      revenue:
                        total: 32.96
                        calculated_at: 2026-01-31T12:00:00+00:00
                  _meta:
                    _credits:
                      used: 0
                      balance: 999999
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                properties:
                  data:
                    type: array
                    example:
                      - onlyfans_id: "100000001"
                        username: demo_spender_a
                        revenue:
                          total: 109.88
                          calculated_at: 2026-01-31T12:00:00+00:00
                      - onlyfans_id: "100000002"
                        username: demo_spender_b
                        revenue:
                          total: 32.96
                          calculated_at: 2026-01-31T12:00:00+00:00
                    items:
                      type: object
                      properties:
                        onlyfans_id:
                          type: string
                          example: "100000001"
                        username:
                          type: string
                          example: demo_spender_a
                        revenue:
                          type: object
                          properties:
                            total:
                              type: number
                              example: 109.88
                            calculated_at:
                              type: string
                              example: 2026-01-31T12:00:00+00:00
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 999999
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
      tags:
        - Smart Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Smart Link Tags (/api-reference/smart-links/list-smart-link-tags)

Get tags for a specific Smart Link. This is a free endpoint.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/smart-links/{smart_link_id}/tags
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/smart-links/{smart_link_id}/tags:
    parameters:
      - in: path
        name: smart_link_id
        description: The ID of the Smart Link
        example: 01JCZWQJZXQJZXQJZXQJZXQJZX
        required: true
        schema:
          type: string
    get:
      summary: List Smart Link Tags
      operationId: listSmartLinkTags
      description: Get tags for a specific Smart Link. This is a free endpoint.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  tags:
                    - Instagram
                    - Twitter
                properties:
                  tags:
                    type: array
                    example:
                      - Instagram
                      - Twitter
                    items:
                      type: string
      tags:
        - Smart Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Smart Links (/api-reference/smart-links/list-smart-links)

List all Smart Links

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/smart-links
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/smart-links:
    get:
      summary: List Smart Links
      operationId: listSmartLinks
      description: List all Smart Links
      parameters:
        - in: query
          name: limit
          description: The number of Smart Links to return. Default `50`. Must be at least
            1. Must not be greater than 1000.
          example: 50
          required: false
          schema:
            type: integer
            description: The number of Smart Links to return. Default `50`. Must be at least
              1. Must not be greater than 1000.
            example: 50
        - in: query
          name: offset
          description: The offset used for pagination. Default `0`. Must be at least 0.
          example: 0
          required: false
          schema:
            type: integer
            description: The offset used for pagination. Default `0`. Must be at least 0.
            example: 0
        - in: query
          name: name
          description: Filter Smart Links by name. Must not be greater than 255 characters.
          example: Instagram
          required: false
          schema:
            type: string
            description: Filter Smart Links by name. Must not be greater than 255
              characters.
            example: Instagram
            nullable: true
        - in: query
          name: account_ids
          description: Comma-separated account prefixed IDs to include.
          example: acct_abc123,acct_def456
          required: false
          schema:
            type: string
            description: Comma-separated account prefixed IDs to include.
            example: acct_abc123,acct_def456
            nullable: true
        - in: query
          name: pixel_ids
          description: Comma-separated ad platform Pixel IDs to include.
          example: 1,2
          required: false
          schema:
            type: string
            description: Comma-separated ad platform Pixel IDs to include.
            example: 1,2
            nullable: true
        - in: query
          name: filter
          description: ""
          example: []
          required: false
          schema:
            type: object
            description: ""
            example: []
            properties: {}
        - in: query
          name: filter.tags
          description: Must not be greater than 50 characters.
          example:
            - ytuesipitqtljon
          required: false
          schema:
            type: array
            description: Must not be greater than 50 characters.
            example:
              - ytuesipitqtljon
            items:
              type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - id: 01JCZWQJZXQJZXQJZXQJZXQJZX
                      name: Instagram Bio Link
                      link_type: free_trial
                      traffic_redirect_url: https://trk.of-traffic.com/go/01JCZWQJZXQJZXQJZXQJZXQJZX
                      free_trial_days: 7
                      clicks_count: 150
                      conversions_count: 45
                      subscribers_count: 30
                      spenders_count: 12
                      revenue: "1250.00"
                      cost:
                        inputMode: null
                        inputValue: null
                        perSub: null
                        perClick: null
                        perPromo: null
                        subscriberSourceCount: 30
                        clickSourceCount: 150
                      account:
                        id: acct_XXXXXXXX
                        display_name: Example Creator
                        username: examplecreator
                      created_at: 2025-01-15T10:30:00+00:00
                      updated_at: 2025-01-15T10:30:00+00:00
                    - id: 01JCZWQJZXQJZXQJZXQJZXQJZY
                      name: Twitter Promo
                      link_type: tracking_link
                      traffic_redirect_url: https://trk.of-traffic.com/go/01JCZWQJZXQJZXQJZXQJZXQJZY
                      free_trial_days: null
                      clicks_count: 320
                      conversions_count: 89
                      subscribers_count: 65
                      spenders_count: 24
                      revenue: "2450.50"
                      cost:
                        inputMode: null
                        inputValue: null
                        perSub: null
                        perClick: null
                        perPromo: null
                        subscriberSourceCount: 65
                        clickSourceCount: 320
                      account:
                        id: acct_XXXXXXXX
                        display_name: Example Creator
                        username: examplecreator
                      created_at: 2025-01-10T08:15:00+00:00
                      updated_at: 2025-01-10T08:15:00+00:00
                  _meta:
                    _credits:
                      used: 0
                      balance: 999999985
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999998
                      remaining_day: 49988
                properties:
                  data:
                    type: array
                    example:
                      - id: 01JCZWQJZXQJZXQJZXQJZXQJZX
                        name: Instagram Bio Link
                        link_type: free_trial
                        traffic_redirect_url: https://trk.of-traffic.com/go/01JCZWQJZXQJZXQJZXQJZXQJZX
                        free_trial_days: 7
                        clicks_count: 150
                        conversions_count: 45
                        subscribers_count: 30
                        spenders_count: 12
                        revenue: "1250.00"
                        cost:
                          inputMode: null
                          inputValue: null
                          perSub: null
                          perClick: null
                          perPromo: null
                          subscriberSourceCount: 30
                          clickSourceCount: 150
                        account:
                          id: acct_XXXXXXXX
                          display_name: Example Creator
                          username: examplecreator
                        created_at: 2025-01-15T10:30:00+00:00
                        updated_at: 2025-01-15T10:30:00+00:00
                      - id: 01JCZWQJZXQJZXQJZXQJZXQJZY
                        name: Twitter Promo
                        link_type: tracking_link
                        traffic_redirect_url: https://trk.of-traffic.com/go/01JCZWQJZXQJZXQJZXQJZXQJZY
                        free_trial_days: null
                        clicks_count: 320
                        conversions_count: 89
                        subscribers_count: 65
                        spenders_count: 24
                        revenue: "2450.50"
                        cost:
                          inputMode: null
                          inputValue: null
                          perSub: null
                          perClick: null
                          perPromo: null
                          subscriberSourceCount: 65
                          clickSourceCount: 320
                        account:
                          id: acct_XXXXXXXX
                          display_name: Example Creator
                          username: examplecreator
                        created_at: 2025-01-10T08:15:00+00:00
                        updated_at: 2025-01-10T08:15:00+00:00
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 01JCZWQJZXQJZXQJZXQJZXQJZX
                        name:
                          type: string
                          example: Instagram Bio Link
                        link_type:
                          type: string
                          example: free_trial
                        traffic_redirect_url:
                          type: string
                          example: https://trk.of-traffic.com/go/01JCZWQJZXQJZXQJZXQJZXQJZX
                        free_trial_days:
                          type: integer
                          example: 7
                        clicks_count:
                          type: integer
                          example: 150
                        conversions_count:
                          type: integer
                          example: 45
                        subscribers_count:
                          type: integer
                          example: 30
                        spenders_count:
                          type: integer
                          example: 12
                        revenue:
                          type: string
                          example: "1250.00"
                        cost:
                          type: object
                          properties:
                            inputMode:
                              type: string
                              example: null
                              nullable: true
                            inputValue:
                              type: string
                              example: null
                              nullable: true
                            perSub:
                              type: string
                              example: null
                              nullable: true
                            perClick:
                              type: string
                              example: null
                              nullable: true
                            perPromo:
                              type: string
                              example: null
                              nullable: true
                            subscriberSourceCount:
                              type: integer
                              example: 30
                            clickSourceCount:
                              type: integer
                              example: 150
                        account:
                          type: object
                          properties:
                            id:
                              type: string
                              example: acct_XXXXXXXX
                            display_name:
                              type: string
                              example: Example Creator
                            username:
                              type: string
                              example: examplecreator
                        created_at:
                          type: string
                          example: 2025-01-15T10:30:00+00:00
                        updated_at:
                          type: string
                          example: 2025-01-15T10:30:00+00:00
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 999999985
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999998
                          remaining_day:
                            type: integer
                            example: 49988
      tags:
        - Smart Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Remove Smart Link Tags (/api-reference/smart-links/remove-smart-link-tags)

Remove tags from a specific Smart Link. This is a free endpoint.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/smart-links/{smart_link_id}/tags
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/smart-links/{smart_link_id}/tags:
    parameters:
      - in: path
        name: smart_link_id
        description: The ID of the Smart Link
        example: 01JCZWQJZXQJZXQJZXQJZXQJZX
        required: true
        schema:
          type: string
    delete:
      summary: Remove Smart Link Tags
      operationId: removeSmartLinkTags
      description: Remove tags from a specific Smart Link. This is a free endpoint.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  tags:
                    - Twitter
                properties:
                  tags:
                    type: array
                    example:
                      - Twitter
                    items:
                      type: string
      tags:
        - Smart Links
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tags:
                  type: array
                  description: Array of tag names to remove from the Smart Link.
                  example: '["Instagram"]'
                  items:
                    type: string
              required:
                - tags
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Stored Tracking Links (/api-reference/stored-tracking-links/list-stored-tracking-links)

List all stored tracking links from the OnlyFansAPI Cache. This is a free endpoint that does not call the OnlyFans API.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/stored/tracking-links
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/stored/tracking-links:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Stored Tracking Links
      operationId: listStoredTrackingLinks
      description: List all stored tracking links from the OnlyFansAPI Cache. This is
        a free endpoint that does not call the OnlyFans API.
      parameters:
        - in: query
          name: limit
          description: The number of tracking links to return. Default `10`. Must be at
            least 1. Must not be greater than 1000.
          example: 10
          required: false
          schema:
            type: integer
            description: The number of tracking links to return. Default `10`. Must be at
              least 1. Must not be greater than 1000.
            example: 10
        - in: query
          name: offset
          description: The offset used for pagination. Default `0`. Must be at least 0.
          example: 0
          required: false
          schema:
            type: integer
            description: The offset used for pagination. Default `0`. Must be at least 0.
            example: 0
        - in: query
          name: filter
          description: ""
          example: []
          required: false
          schema:
            type: object
            description: ""
            example: []
            properties: {}
        - in: query
          name: filter.include_smart_links
          description: ""
          example: true
          required: false
          schema:
            type: boolean
            description: ""
            example: true
        - in: query
          name: filter.search
          description: Must not be greater than 255 characters.
          example: lfgjncstypmlveeyplpl
          required: false
          schema:
            type: string
            description: Must not be greater than 255 characters.
            example: lfgjncstypmlveeyplpl
            nullable: true
        - in: query
          name: filter.tags
          description: Must not be greater than 50 characters.
          example:
            - imtaqthazfxldysiweqf
          required: false
          schema:
            type: array
            description: Must not be greater than 50 characters.
            example:
              - imtaqthazfxldysiweqf
            items:
              type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - id: 123456
                        campaignCode: 123
                        campaignName: Example Campaign - IG Bio SFS
                        campaignUrl: https://onlyfans.com/USERNAME/c123
                        subscribersCount: 10
                        clicksCount: 100
                        createdAt: 2025-01-01T00:00:00+00:00
                        endDate: null
                        tags:
                          - Instagram
                          - Twitter
                        revenue:
                          total: 20
                          revenuePerSubscriber: 2
                          revenuePerClick: 0.2
                          spendersCount: 1
                          calculatedAt: 2025-01-01T00:00:00+00:00
                          isLoading: false
                        cost:
                          inputMode: null
                          inputValue: null
                          perSub: null
                          perClick: null
                          perPromo: null
                          subscriberSourceCount: 10
                          clickSourceCount: 100
                        links:
                          related:
                            subscribers: https://app.onlyfansapi.com/api/acct_XXXXXXX/tracking-links/123456/subscribers
                            spenders: https://app.onlyfansapi.com/api/acct_XXXXXXX/tracking-links/123456/spenders
                    hasMore: true
                  _pagination:
                    next_page: https://app.onlyfansapi.com/api/acct_XXXXXXXXXXX/stored/tracking-links?offset=10&limit=10
                  _meta:
                    _credits:
                      used: 0
                      balance: 9529
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49999
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - id: 123456
                            campaignCode: 123
                            campaignName: Example Campaign - IG Bio SFS
                            campaignUrl: https://onlyfans.com/USERNAME/c123
                            subscribersCount: 10
                            clicksCount: 100
                            createdAt: 2025-01-01T00:00:00+00:00
                            endDate: null
                            tags:
                              - Instagram
                              - Twitter
                            revenue:
                              total: 20
                              revenuePerSubscriber: 2
                              revenuePerClick: 0.2
                              spendersCount: 1
                              calculatedAt: 2025-01-01T00:00:00+00:00
                              isLoading: false
                            cost:
                              inputMode: null
                              inputValue: null
                              perSub: null
                              perClick: null
                              perPromo: null
                              subscriberSourceCount: 10
                              clickSourceCount: 100
                            links:
                              related:
                                subscribers: https://app.onlyfansapi.com/api/acct_XXXXXXX/tracking-links/123456/subscribers
                                spenders: https://app.onlyfansapi.com/api/acct_XXXXXXX/tracking-links/123456/spenders
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123456
                            campaignCode:
                              type: integer
                              example: 123
                            campaignName:
                              type: string
                              example: Example Campaign - IG Bio SFS
                            campaignUrl:
                              type: string
                              example: https://onlyfans.com/USERNAME/c123
                            subscribersCount:
                              type: integer
                              example: 10
                            clicksCount:
                              type: integer
                              example: 100
                            createdAt:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            endDate:
                              type: string
                              example: null
                              nullable: true
                            tags:
                              type: array
                              example:
                                - Instagram
                                - Twitter
                              items:
                                type: string
                            revenue:
                              type: object
                              properties:
                                total:
                                  type: integer
                                  example: 20
                                revenuePerSubscriber:
                                  type: integer
                                  example: 2
                                revenuePerClick:
                                  type: number
                                  example: 0.2
                                spendersCount:
                                  type: integer
                                  example: 1
                                calculatedAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                isLoading:
                                  type: boolean
                                  example: false
                            cost:
                              type: object
                              properties:
                                inputMode:
                                  type: string
                                  example: null
                                  nullable: true
                                inputValue:
                                  type: string
                                  example: null
                                  nullable: true
                                perSub:
                                  type: string
                                  example: null
                                  nullable: true
                                perClick:
                                  type: string
                                  example: null
                                  nullable: true
                                perPromo:
                                  type: string
                                  example: null
                                  nullable: true
                                subscriberSourceCount:
                                  type: integer
                                  example: 10
                                clickSourceCount:
                                  type: integer
                                  example: 100
                            links:
                              type: object
                              properties:
                                related:
                                  type: object
                                  properties:
                                    subscribers:
                                      type: string
                                      example: https://app.onlyfansapi.com/api/acct_XXXXXXX/tracking-links/123456/subscribers
                                    spenders:
                                      type: string
                                      example: https://app.onlyfansapi.com/api/acct_XXXXXXX/tracking-links/123456/spenders
                      hasMore:
                        type: boolean
                        example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: https://app.onlyfansapi.com/api/acct_XXXXXXXXXXX/stored/tracking-links?offset=10&limit=10
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9529
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49999
      tags:
        - Stored Tracking Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Add to Story (/api-reference/stories/add-to-story)

Post a new media or vault file to your story.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/stories
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/stories:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Add to Story
      operationId: addToStory
      description: Post a new media or vault file to your story.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    userId: 123
                    isReady: false
                    hasPost: false
                    isWatched: false
                    media:
                      - id: 123
                        type: photo
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: 2025-01-01T01:01:01+00:00
                        isReady: false
                        files:
                          full:
                            url: null
                            width: 0
                            height: 0
                            size: 0
                            sources: []
                          thumb: null
                          preview: null
                          squarePreview: null
                        duration: 0
                        hasCustomPreview: false
                    createdAt: 2025-01-01T01:01:01+00:00
                    question: null
                    viewersCount: 0
                    viewers: []
                    commentsCount: 0
                    canDelete: true
                    isHighlightCover: false
                    isLastInHighlight: false
                    tipsAmount: $0
                    tipsAmountRaw: 0
                    tipsCount: 0
                    likesCount: 0
                    releaseForms: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999771
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4995
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      userId:
                        type: integer
                        example: 123
                      isReady:
                        type: boolean
                        example: false
                      hasPost:
                        type: boolean
                        example: false
                      isWatched:
                        type: boolean
                        example: false
                      media:
                        type: array
                        example:
                          - id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: 2025-01-01T01:01:01+00:00
                            isReady: false
                            files:
                              full:
                                url: null
                                width: 0
                                height: 0
                                size: 0
                                sources: []
                              thumb: null
                              preview: null
                              squarePreview: null
                            duration: 0
                            hasCustomPreview: false
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            type:
                              type: string
                              example: photo
                            convertedToVideo:
                              type: boolean
                              example: false
                            canView:
                              type: boolean
                              example: true
                            hasError:
                              type: boolean
                              example: false
                            createdAt:
                              type: string
                              example: 2025-01-01T01:01:01+00:00
                            isReady:
                              type: boolean
                              example: false
                            files:
                              type: object
                              properties:
                                full:
                                  type: object
                                  properties:
                                    url:
                                      type: string
                                      example: null
                                      nullable: true
                                    width:
                                      type: integer
                                      example: 0
                                    height:
                                      type: integer
                                      example: 0
                                    size:
                                      type: integer
                                      example: 0
                                    sources:
                                      type: array
                                      example: []
                                thumb:
                                  type: string
                                  example: null
                                  nullable: true
                                preview:
                                  type: string
                                  example: null
                                  nullable: true
                                squarePreview:
                                  type: string
                                  example: null
                                  nullable: true
                            duration:
                              type: integer
                              example: 0
                            hasCustomPreview:
                              type: boolean
                              example: false
                      createdAt:
                        type: string
                        example: 2025-01-01T01:01:01+00:00
                      question:
                        type: string
                        example: null
                        nullable: true
                      viewersCount:
                        type: integer
                        example: 0
                      viewers:
                        type: array
                        example: []
                      commentsCount:
                        type: integer
                        example: 0
                      canDelete:
                        type: boolean
                        example: true
                      isHighlightCover:
                        type: boolean
                        example: false
                      isLastInHighlight:
                        type: boolean
                        example: false
                      tipsAmount:
                        type: string
                        example: $0
                      tipsAmountRaw:
                        type: integer
                        example: 0
                      tipsCount:
                        type: integer
                        example: 0
                      likesCount:
                        type: integer
                        example: 0
                      releaseForms:
                        type: array
                        example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999771
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4995
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Stories
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                mediaFiles:
                  type: array
                  description: Array of media file upload prefixed_ids, or OF media IDs (required
                    if price is not 0).
                  example:
                    - ofapi_media_abc123
                    - 1234567890
                  items:
                    type: string
              required:
                - mediaFiles
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Delete Story (/api-reference/stories/delete-story)

Delete a specific story by its ID.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/stories/{story_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/stories/{story_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: story_id
        description: The ID of the story to retrieve
        example: 1234567890
        required: true
        schema:
          type: integer
    delete:
      summary: Delete Story
      operationId: deleteStory
      description: Delete a specific story by its ID.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999765
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4998
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999765
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4998
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Stories
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Story Stats (/api-reference/stories/get-story-stats)

Retrieve viewer count, likes count, comments count, and tips statistics for a specific story by its ID.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/stories/{story_id}/stats
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/stories/{story_id}/stats:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: story_id
        description: The ID of the story to get stats for
        example: 1234567890
        required: true
        schema:
          type: integer
    get:
      summary: Get Story Stats
      operationId: getStoryStats
      description: Retrieve viewer count, likes count, comments count, and tips
        statistics for a specific story by its ID.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    storyLookCount: "123"
                    storyLookAll:
                      - 2025-01-01T01:01:01+00:00
                    storyLikeCount: 123
                    storyLikeAll:
                      - 2025-01-01T01:01:01+00:00
                    storyCommentCount: 123
                    storyCommentAll:
                      - 2025-01-01T01:01:01+00:00
                    storyTipCount: 123
                    storyTipAll:
                      - 2025-01-01T01:01:01+00:00
                    storyTipSum: 0
                    storyLookChart:
                      - date: 2025-01-01T01:01:01+00:00
                        count: 123
                      - count: 123
                    storyLikeChart:
                      - date: 2025-01-01T01:01:01+00:00
                        count: 123
                    storyCommentChart:
                      - date: 2025-01-01T01:01:01+00:00
                        count: 123
                    storyTipChart:
                      - date: 2025-01-01T01:01:01+00:00
                        count: 123
                    storyTipSumChart:
                      - date: 2025-01-01T01:01:01+00:00
                        count: 123
                    createdAt: 2025-01-01T01:01:01+00:00
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999719
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      storyLookCount:
                        type: string
                        example: "123"
                      storyLookAll:
                        type: array
                        example:
                          - 2025-01-01T01:01:01+00:00
                        items:
                          type: string
                      storyLikeCount:
                        type: integer
                        example: 123
                      storyLikeAll:
                        type: array
                        example:
                          - 2025-01-01T01:01:01+00:00
                        items:
                          type: string
                      storyCommentCount:
                        type: integer
                        example: 123
                      storyCommentAll:
                        type: array
                        example:
                          - 2025-01-01T01:01:01+00:00
                        items:
                          type: string
                      storyTipCount:
                        type: integer
                        example: 123
                      storyTipAll:
                        type: array
                        example:
                          - 2025-01-01T01:01:01+00:00
                        items:
                          type: string
                      storyTipSum:
                        type: integer
                        example: 0
                      storyLookChart:
                        type: array
                        example:
                          - date: 2025-01-01T01:01:01+00:00
                            count: 123
                          - count: 123
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: 2025-01-01T01:01:01+00:00
                            count:
                              type: integer
                              example: 123
                      storyLikeChart:
                        type: array
                        example:
                          - date: 2025-01-01T01:01:01+00:00
                            count: 123
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: 2025-01-01T01:01:01+00:00
                            count:
                              type: integer
                              example: 123
                      storyCommentChart:
                        type: array
                        example:
                          - date: 2025-01-01T01:01:01+00:00
                            count: 123
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: 2025-01-01T01:01:01+00:00
                            count:
                              type: integer
                              example: 123
                      storyTipChart:
                        type: array
                        example:
                          - date: 2025-01-01T01:01:01+00:00
                            count: 123
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: 2025-01-01T01:01:01+00:00
                            count:
                              type: integer
                              example: 123
                      storyTipSumChart:
                        type: array
                        example:
                          - date: 2025-01-01T01:01:01+00:00
                            count: 123
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: 2025-01-01T01:01:01+00:00
                            count:
                              type: integer
                              example: 123
                      createdAt:
                        type: string
                        example: 2025-01-01T01:01:01+00:00
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999719
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Stories
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Active Stories (/api-reference/stories/list-active-stories)

Retrieve a list of your currently active stories.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/stories
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/stories:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Active Stories
      operationId: listActiveStories
      description: Retrieve a list of your currently active stories.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - id: 123
                      userId: 123
                      isReady: true
                      hasPost: false
                      isWatched: true
                      media:
                        - id: 123
                          type: photo
                          convertedToVideo: false
                          canView: true
                          hasError: false
                          createdAt: 2025-01-01T01:01:01+00:00
                          isReady: true
                          files:
                            full:
                              url: https://cdn2.onlyfans.com/files/...
                              width: 600
                              height: 400
                              size: 0
                              sources: []
                            thumb:
                              url: https://cdn2.onlyfans.com/files/...
                              width: 300
                              height: 300
                              size: 0
                            preview:
                              url: https://cdn2.onlyfans.com/files/...
                              width: 600
                              height: 400
                              size: 0
                              sources:
                                w150: https://cdn2.onlyfans.com/files/...
                            squarePreview:
                              url: https://cdn2.onlyfans.com/files/...
                              width: 960
                              height: 960
                              size: 0
                              sources:
                                w150: https://thumbs.onlyfans.com/...
                                w480: https://thumbs.onlyfans.com/...
                          duration: 0
                          hasCustomPreview: false
                          videoSources:
                            "240": null
                            "720": null
                      createdAt: 2025-01-01T01:01:01+00:00
                      question: null
                      viewersCount: 0
                      viewers: []
                      commentsCount: 0
                      canDelete: true
                      isHighlightCover: false
                      isLastInHighlight: false
                      tipsAmount: $0
                      tipsAmountRaw: 0
                      tipsCount: 0
                      likesCount: 0
                      releaseForms: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999770
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4996
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: array
                    example:
                      - id: 123
                        userId: 123
                        isReady: true
                        hasPost: false
                        isWatched: true
                        media:
                          - id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: 2025-01-01T01:01:01+00:00
                            isReady: true
                            files:
                              full:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 600
                                height: 400
                                size: 0
                                sources: []
                              thumb:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 600
                                height: 400
                                size: 0
                                sources:
                                  w150: https://cdn2.onlyfans.com/files/...
                              squarePreview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 960
                                height: 960
                                size: 0
                                sources:
                                  w150: https://thumbs.onlyfans.com/...
                                  w480: https://thumbs.onlyfans.com/...
                            duration: 0
                            hasCustomPreview: false
                            videoSources:
                              "240": null
                              "720": null
                        createdAt: 2025-01-01T01:01:01+00:00
                        question: null
                        viewersCount: 0
                        viewers: []
                        commentsCount: 0
                        canDelete: true
                        isHighlightCover: false
                        isLastInHighlight: false
                        tipsAmount: $0
                        tipsAmountRaw: 0
                        tipsCount: 0
                        likesCount: 0
                        releaseForms: []
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 123
                        userId:
                          type: integer
                          example: 123
                        isReady:
                          type: boolean
                          example: true
                        hasPost:
                          type: boolean
                          example: false
                        isWatched:
                          type: boolean
                          example: true
                        media:
                          type: array
                          example:
                            - id: 123
                              type: photo
                              convertedToVideo: false
                              canView: true
                              hasError: false
                              createdAt: 2025-01-01T01:01:01+00:00
                              isReady: true
                              files:
                                full:
                                  url: https://cdn2.onlyfans.com/files/...
                                  width: 600
                                  height: 400
                                  size: 0
                                  sources: []
                                thumb:
                                  url: https://cdn2.onlyfans.com/files/...
                                  width: 300
                                  height: 300
                                  size: 0
                                preview:
                                  url: https://cdn2.onlyfans.com/files/...
                                  width: 600
                                  height: 400
                                  size: 0
                                  sources:
                                    w150: https://cdn2.onlyfans.com/files/...
                                squarePreview:
                                  url: https://cdn2.onlyfans.com/files/...
                                  width: 960
                                  height: 960
                                  size: 0
                                  sources:
                                    w150: https://thumbs.onlyfans.com/...
                                    w480: https://thumbs.onlyfans.com/...
                              duration: 0
                              hasCustomPreview: false
                              videoSources:
                                "240": null
                                "720": null
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 123
                              type:
                                type: string
                                example: photo
                              convertedToVideo:
                                type: boolean
                                example: false
                              canView:
                                type: boolean
                                example: true
                              hasError:
                                type: boolean
                                example: false
                              createdAt:
                                type: string
                                example: 2025-01-01T01:01:01+00:00
                              isReady:
                                type: boolean
                                example: true
                              files:
                                type: object
                                properties:
                                  full:
                                    type: object
                                    properties:
                                      url:
                                        type: string
                                        example: https://cdn2.onlyfans.com/files/...
                                      width:
                                        type: integer
                                        example: 600
                                      height:
                                        type: integer
                                        example: 400
                                      size:
                                        type: integer
                                        example: 0
                                      sources:
                                        type: array
                                        example: []
                                  thumb:
                                    type: object
                                    properties:
                                      url:
                                        type: string
                                        example: https://cdn2.onlyfans.com/files/...
                                      width:
                                        type: integer
                                        example: 300
                                      height:
                                        type: integer
                                        example: 300
                                      size:
                                        type: integer
                                        example: 0
                                  preview:
                                    type: object
                                    properties:
                                      url:
                                        type: string
                                        example: https://cdn2.onlyfans.com/files/...
                                      width:
                                        type: integer
                                        example: 600
                                      height:
                                        type: integer
                                        example: 400
                                      size:
                                        type: integer
                                        example: 0
                                      sources:
                                        type: object
                                        properties:
                                          w150:
                                            type: string
                                            example: https://cdn2.onlyfans.com/files/...
                                  squarePreview:
                                    type: object
                                    properties:
                                      url:
                                        type: string
                                        example: https://cdn2.onlyfans.com/files/...
                                      width:
                                        type: integer
                                        example: 960
                                      height:
                                        type: integer
                                        example: 960
                                      size:
                                        type: integer
                                        example: 0
                                      sources:
                                        type: object
                                        properties:
                                          w150:
                                            type: string
                                            example: https://thumbs.onlyfans.com/...
                                          w480:
                                            type: string
                                            example: https://thumbs.onlyfans.com/...
                              duration:
                                type: integer
                                example: 0
                              hasCustomPreview:
                                type: boolean
                                example: false
                              videoSources:
                                type: object
                                properties:
                                  "240":
                                    type: string
                                    example: null
                                    nullable: true
                                  "720":
                                    type: string
                                    example: null
                                    nullable: true
                        createdAt:
                          type: string
                          example: 2025-01-01T01:01:01+00:00
                        question:
                          type: string
                          example: null
                          nullable: true
                        viewersCount:
                          type: integer
                          example: 0
                        viewers:
                          type: array
                          example: []
                        commentsCount:
                          type: integer
                          example: 0
                        canDelete:
                          type: boolean
                          example: true
                        isHighlightCover:
                          type: boolean
                          example: false
                        isLastInHighlight:
                          type: boolean
                          example: false
                        tipsAmount:
                          type: string
                          example: $0
                        tipsAmountRaw:
                          type: integer
                          example: 0
                        tipsCount:
                          type: integer
                          example: 0
                        likesCount:
                          type: integer
                          example: 0
                        releaseForms:
                          type: array
                          example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999770
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4996
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Stories
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Story Archive (/api-reference/stories/list-story-archive)

Retrieve a list of your archived stories.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/stories/archive
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/stories/archive:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Story Archive
      operationId: listStoryArchive
      description: Retrieve a list of your archived stories.
      parameters:
        - in: query
          name: limit
          description: Number of stories to return (default = 18)
          example: 18
          required: false
          schema:
            type: integer
            description: Number of stories to return (default = 18)
            example: 18
        - in: query
          name: marker
          description: "The marker used for pagination. Default: `null`"
          example: "1739155047"
          required: false
          schema:
            type: string
            description: "The marker used for pagination. Default: `null`"
            example: "1739155047"
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - id: 123
                        createdAt: 2025-01-01T01:01:01+00:00
                        media:
                          - id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: 2025-01-01T01:01:01+00:00
                            isReady: true
                            files:
                              full:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 600
                                height: 400
                                size: 0
                                sources: []
                              thumb:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 600
                                height: 400
                                size: 0
                                sources:
                                  w150: https://cdn2.onlyfans.com/files/...
                              squarePreview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 960
                                height: 960
                                size: 0
                                sources:
                                  w150: https://thumbs.onlyfans.com/...
                                  w480: https://thumbs.onlyfans.com/...
                            duration: 0
                            hasCustomPreview: false
                            videoSources:
                              "240": null
                              "720": null
                        question: null
                    marker: 123
                    hasMore: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999751
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - id: 123
                            createdAt: 2025-01-01T01:01:01+00:00
                            media:
                              - id: 123
                                type: photo
                                convertedToVideo: false
                                canView: true
                                hasError: false
                                createdAt: 2025-01-01T01:01:01+00:00
                                isReady: true
                                files:
                                  full:
                                    url: https://cdn2.onlyfans.com/files/...
                                    width: 600
                                    height: 400
                                    size: 0
                                    sources: []
                                  thumb:
                                    url: https://cdn2.onlyfans.com/files/...
                                    width: 300
                                    height: 300
                                    size: 0
                                  preview:
                                    url: https://cdn2.onlyfans.com/files/...
                                    width: 600
                                    height: 400
                                    size: 0
                                    sources:
                                      w150: https://cdn2.onlyfans.com/files/...
                                  squarePreview:
                                    url: https://cdn2.onlyfans.com/files/...
                                    width: 960
                                    height: 960
                                    size: 0
                                    sources:
                                      w150: https://thumbs.onlyfans.com/...
                                      w480: https://thumbs.onlyfans.com/...
                                duration: 0
                                hasCustomPreview: false
                                videoSources:
                                  "240": null
                                  "720": null
                            question: null
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            createdAt:
                              type: string
                              example: 2025-01-01T01:01:01+00:00
                            media:
                              type: array
                              example:
                                - id: 123
                                  type: photo
                                  convertedToVideo: false
                                  canView: true
                                  hasError: false
                                  createdAt: 2025-01-01T01:01:01+00:00
                                  isReady: true
                                  files:
                                    full:
                                      url: https://cdn2.onlyfans.com/files/...
                                      width: 600
                                      height: 400
                                      size: 0
                                      sources: []
                                    thumb:
                                      url: https://cdn2.onlyfans.com/files/...
                                      width: 300
                                      height: 300
                                      size: 0
                                    preview:
                                      url: https://cdn2.onlyfans.com/files/...
                                      width: 600
                                      height: 400
                                      size: 0
                                      sources:
                                        w150: https://cdn2.onlyfans.com/files/...
                                    squarePreview:
                                      url: https://cdn2.onlyfans.com/files/...
                                      width: 960
                                      height: 960
                                      size: 0
                                      sources:
                                        w150: https://thumbs.onlyfans.com/...
                                        w480: https://thumbs.onlyfans.com/...
                                  duration: 0
                                  hasCustomPreview: false
                                  videoSources:
                                    "240": null
                                    "720": null
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  type:
                                    type: string
                                    example: photo
                                  convertedToVideo:
                                    type: boolean
                                    example: false
                                  canView:
                                    type: boolean
                                    example: true
                                  hasError:
                                    type: boolean
                                    example: false
                                  createdAt:
                                    type: string
                                    example: 2025-01-01T01:01:01+00:00
                                  isReady:
                                    type: boolean
                                    example: true
                                  files:
                                    type: object
                                    properties:
                                      full:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                            example: https://cdn2.onlyfans.com/files/...
                                          width:
                                            type: integer
                                            example: 600
                                          height:
                                            type: integer
                                            example: 400
                                          size:
                                            type: integer
                                            example: 0
                                          sources:
                                            type: array
                                            example: []
                                      thumb:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                            example: https://cdn2.onlyfans.com/files/...
                                          width:
                                            type: integer
                                            example: 300
                                          height:
                                            type: integer
                                            example: 300
                                          size:
                                            type: integer
                                            example: 0
                                      preview:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                            example: https://cdn2.onlyfans.com/files/...
                                          width:
                                            type: integer
                                            example: 600
                                          height:
                                            type: integer
                                            example: 400
                                          size:
                                            type: integer
                                            example: 0
                                          sources:
                                            type: object
                                            properties:
                                              w150:
                                                type: string
                                                example: https://cdn2.onlyfans.com/files/...
                                      squarePreview:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                            example: https://cdn2.onlyfans.com/files/...
                                          width:
                                            type: integer
                                            example: 960
                                          height:
                                            type: integer
                                            example: 960
                                          size:
                                            type: integer
                                            example: 0
                                          sources:
                                            type: object
                                            properties:
                                              w150:
                                                type: string
                                                example: https://thumbs.onlyfans.com/...
                                              w480:
                                                type: string
                                                example: https://thumbs.onlyfans.com/...
                                  duration:
                                    type: integer
                                    example: 0
                                  hasCustomPreview:
                                    type: boolean
                                    example: false
                                  videoSources:
                                    type: object
                                    properties:
                                      "240":
                                        type: string
                                        example: null
                                        nullable: true
                                      "720":
                                        type: string
                                        example: null
                                        nullable: true
                            question:
                              type: string
                              example: null
                              nullable: true
                      marker:
                        type: integer
                        example: 123
                      hasMore:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999751
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Stories
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Story Viewers (/api-reference/stories/list-story-viewers)

Retrieve the list of viewers for a specific story by its ID.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/stories/{story_id}/viewers
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/stories/{story_id}/viewers:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: story_id
        description: The ID of the story to get viewers for
        example: 1234567890
        required: true
        schema:
          type: integer
    get:
      summary: List Story Viewers
      operationId: listStoryViewers
      description: Retrieve the list of viewers for a specific story by its ID.
      parameters:
        - in: query
          name: limit
          description: The number of story viewers to return. Default `8`
          example: 8
          required: false
          schema:
            type: integer
            description: The number of story viewers to return. Default `8`
            example: 8
            nullable: true
        - in: query
          name: offset
          description: The offset used for pagination. Default `0`
          example: 0
          required: false
          schema:
            type: integer
            description: The offset used for pagination. Default `0`
            example: 0
            nullable: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    hasMore: true
                    list:
                      - view: s
                        hasStoryTips: false
                        hasTopStoryTips: false
                        avatar: null
                        avatarThumbs: null
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 123
                        name: name
                        username: username
                        canLookStory: true
                        canCommentStory: true
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: true
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        isStoryLiked: false
                        isStoryBlockedUser: false
                        displayName: ""
                        notice: ""
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: true
                        subscribedByExpire: false
                        subscribedByExpireDate: 2025-01-01T01:01:01+00:00
                        subscribedByAutoprolong: true
                        subscribedIsExpiredNow: false
                        currentSubscribePrice: 0
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: ""
                        listsStates:
                          - id: fans
                            type: fans
                            name: Fans
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          - id: recent
                            type: recent
                            name: Recent (last 24 hours)
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: USER_NOT_PERFORMER
                          - id: rebill_off
                            type: rebill_off
                            name: Renew Off
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          - id: rebill_on
                            type: rebill_on
                            name: Renew On
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                        showMediaCount: true
                        lastSeen: 2025-01-01T01:01:01+00:00
                        canReport: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999710
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4996
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      hasMore:
                        type: boolean
                        example: true
                      list:
                        type: array
                        example:
                          - view: s
                            hasStoryTips: false
                            hasTopStoryTips: false
                            avatar: null
                            avatarThumbs: null
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 123
                            name: name
                            username: username
                            canLookStory: true
                            canCommentStory: true
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: true
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            isStoryLiked: false
                            isStoryBlockedUser: false
                            displayName: ""
                            notice: ""
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: true
                            subscribedByExpire: false
                            subscribedByExpireDate: 2025-01-01T01:01:01+00:00
                            subscribedByAutoprolong: true
                            subscribedIsExpiredNow: false
                            currentSubscribePrice: 0
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: ""
                            listsStates:
                              - id: fans
                                type: fans
                                name: Fans
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              - id: following
                                type: following
                                name: Following
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              - id: muted
                                type: muted
                                name: Muted
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                              - id: recent
                                type: recent
                                name: Recent (last 24 hours)
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              - id: friends
                                type: friends
                                name: Friends
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: USER_NOT_PERFORMER
                              - id: rebill_off
                                type: rebill_off
                                name: Renew Off
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: null
                              - id: rebill_on
                                type: rebill_on
                                name: Renew On
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              - id: tagged
                                type: tagged
                                name: Tagged
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                            showMediaCount: true
                            lastSeen: 2025-01-01T01:01:01+00:00
                            canReport: true
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: s
                            hasStoryTips:
                              type: boolean
                              example: false
                            hasTopStoryTips:
                              type: boolean
                              example: false
                            avatar:
                              type: string
                              example: null
                              nullable: true
                            avatarThumbs:
                              type: string
                              example: null
                              nullable: true
                            header:
                              type: string
                              example: null
                              nullable: true
                            headerSize:
                              type: string
                              example: null
                              nullable: true
                            headerThumbs:
                              type: string
                              example: null
                              nullable: true
                            id:
                              type: integer
                              example: 123
                            name:
                              type: string
                              example: name
                            username:
                              type: string
                              example: username
                            canLookStory:
                              type: boolean
                              example: true
                            canCommentStory:
                              type: boolean
                              example: true
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: false
                            canPayInternal:
                              type: boolean
                              example: true
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: false
                            tipsTextEnabled:
                              type: boolean
                              example: true
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: false
                            canAddSubscriber:
                              type: boolean
                              example: false
                            subscribePrice:
                              type: integer
                              example: 0
                            isStoryLiked:
                              type: boolean
                              example: false
                            isStoryBlockedUser:
                              type: boolean
                              example: false
                            displayName:
                              type: string
                              example: ""
                            notice:
                              type: string
                              example: ""
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: true
                            subscribedByExpire:
                              type: boolean
                              example: false
                            subscribedByExpireDate:
                              type: string
                              example: 2025-01-01T01:01:01+00:00
                            subscribedByAutoprolong:
                              type: boolean
                              example: true
                            subscribedIsExpiredNow:
                              type: boolean
                              example: false
                            currentSubscribePrice:
                              type: integer
                              example: 0
                            subscribedOn:
                              type: boolean
                              example: true
                            subscribedOnExpiredNow:
                              type: boolean
                              example: false
                            subscribedOnDuration:
                              type: string
                              example: ""
                            listsStates:
                              type: array
                              example:
                                - id: fans
                                  type: fans
                                  name: Fans
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                - id: following
                                  type: following
                                  name: Following
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                - id: muted
                                  type: muted
                                  name: Muted
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                                - id: recent
                                  type: recent
                                  name: Recent (last 24 hours)
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                - id: friends
                                  type: friends
                                  name: Friends
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: USER_NOT_PERFORMER
                                - id: rebill_off
                                  type: rebill_off
                                  name: Renew Off
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: null
                                - id: rebill_on
                                  type: rebill_on
                                  name: Renew On
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                - id: tagged
                                  type: tagged
                                  name: Tagged
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: fans
                                  type:
                                    type: string
                                    example: fans
                                  name:
                                    type: string
                                    example: Fans
                                  hasUser:
                                    type: boolean
                                    example: true
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: ALREADY_EXISTS
                            showMediaCount:
                              type: boolean
                              example: true
                            lastSeen:
                              type: string
                              example: 2025-01-01T01:01:01+00:00
                            canReport:
                              type: boolean
                              example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999710
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4996
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Stories
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Mark Story as Watched (/api-reference/stories/mark-story-as-watched)

Mark a specific story as watched by its ID.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/stories/{story_id}/mark-as-watched
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/stories/{story_id}/mark-as-watched:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: story_id
        description: The ID of the story to mark as watched.
        example: 1234567890
        required: true
        schema:
          type: integer
    post:
      summary: Mark Story as Watched
      operationId: markStoryAsWatched
      description: Mark a specific story as watched by its ID.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999764
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999764
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Stories
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Show Story (/api-reference/stories/show-story)

Retrieve details of a specific story by its ID.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/stories/{story_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/stories/{story_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: story_id
        description: The ID of the story to retrieve
        example: 1234567890
        required: true
        schema:
          type: integer
    get:
      summary: Show Story
      operationId: showStory
      description: Retrieve details of a specific story by its ID.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    userId: 123
                    isReady: true
                    hasPost: false
                    isWatched: false
                    media:
                      - id: 213
                        type: photo
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: 2025-01-01T01:01:01+00:00
                        isReady: true
                        files:
                          full:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 600
                            height: 400
                            size: 0
                            sources: []
                          thumb:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 300
                            height: 300
                            size: 0
                          preview:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 600
                            height: 400
                            size: 0
                            sources:
                              w150: https://cdn2.onlyfans.com/files/...
                          squarePreview:
                            url: https://cdn2.onlyfans.com/files/...
                            width: 960
                            height: 960
                            size: 0
                            sources:
                              w150: https://thumbs.onlyfans.com/...
                              w480: https://thumbs.onlyfans.com/...
                        duration: 0
                        hasCustomPreview: false
                        videoSources:
                          "240": null
                          "720": null
                    createdAt: 2025-01-01T01:01:01+00:00
                    question: null
                    viewersCount: 0
                    viewers: []
                    commentsCount: 0
                    canDelete: true
                    isHighlightCover: false
                    isLastInHighlight: false
                    tipsAmount: $0
                    tipsAmountRaw: 0
                    tipsCount: 0
                    likesCount: 0
                    releaseForms: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999767
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4997
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      userId:
                        type: integer
                        example: 123
                      isReady:
                        type: boolean
                        example: true
                      hasPost:
                        type: boolean
                        example: false
                      isWatched:
                        type: boolean
                        example: false
                      media:
                        type: array
                        example:
                          - id: 213
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: 2025-01-01T01:01:01+00:00
                            isReady: true
                            files:
                              full:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 600
                                height: 400
                                size: 0
                                sources: []
                              thumb:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 600
                                height: 400
                                size: 0
                                sources:
                                  w150: https://cdn2.onlyfans.com/files/...
                              squarePreview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 960
                                height: 960
                                size: 0
                                sources:
                                  w150: https://thumbs.onlyfans.com/...
                                  w480: https://thumbs.onlyfans.com/...
                            duration: 0
                            hasCustomPreview: false
                            videoSources:
                              "240": null
                              "720": null
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 213
                            type:
                              type: string
                              example: photo
                            convertedToVideo:
                              type: boolean
                              example: false
                            canView:
                              type: boolean
                              example: true
                            hasError:
                              type: boolean
                              example: false
                            createdAt:
                              type: string
                              example: 2025-01-01T01:01:01+00:00
                            isReady:
                              type: boolean
                              example: true
                            files:
                              type: object
                              properties:
                                full:
                                  type: object
                                  properties:
                                    url:
                                      type: string
                                      example: https://cdn2.onlyfans.com/files/...
                                    width:
                                      type: integer
                                      example: 600
                                    height:
                                      type: integer
                                      example: 400
                                    size:
                                      type: integer
                                      example: 0
                                    sources:
                                      type: array
                                      example: []
                                thumb:
                                  type: object
                                  properties:
                                    url:
                                      type: string
                                      example: https://cdn2.onlyfans.com/files/...
                                    width:
                                      type: integer
                                      example: 300
                                    height:
                                      type: integer
                                      example: 300
                                    size:
                                      type: integer
                                      example: 0
                                preview:
                                  type: object
                                  properties:
                                    url:
                                      type: string
                                      example: https://cdn2.onlyfans.com/files/...
                                    width:
                                      type: integer
                                      example: 600
                                    height:
                                      type: integer
                                      example: 400
                                    size:
                                      type: integer
                                      example: 0
                                    sources:
                                      type: object
                                      properties:
                                        w150:
                                          type: string
                                          example: https://cdn2.onlyfans.com/files/...
                                squarePreview:
                                  type: object
                                  properties:
                                    url:
                                      type: string
                                      example: https://cdn2.onlyfans.com/files/...
                                    width:
                                      type: integer
                                      example: 960
                                    height:
                                      type: integer
                                      example: 960
                                    size:
                                      type: integer
                                      example: 0
                                    sources:
                                      type: object
                                      properties:
                                        w150:
                                          type: string
                                          example: https://thumbs.onlyfans.com/...
                                        w480:
                                          type: string
                                          example: https://thumbs.onlyfans.com/...
                            duration:
                              type: integer
                              example: 0
                            hasCustomPreview:
                              type: boolean
                              example: false
                            videoSources:
                              type: object
                              properties:
                                "240":
                                  type: string
                                  example: null
                                  nullable: true
                                "720":
                                  type: string
                                  example: null
                                  nullable: true
                      createdAt:
                        type: string
                        example: 2025-01-01T01:01:01+00:00
                      question:
                        type: string
                        example: null
                        nullable: true
                      viewersCount:
                        type: integer
                        example: 0
                      viewers:
                        type: array
                        example: []
                      commentsCount:
                        type: integer
                        example: 0
                      canDelete:
                        type: boolean
                        example: true
                      isHighlightCover:
                        type: boolean
                        example: false
                      isLastInHighlight:
                        type: boolean
                        example: false
                      tipsAmount:
                        type: string
                        example: $0
                      tipsAmountRaw:
                        type: integer
                        example: 0
                      tipsCount:
                        type: integer
                        example: 0
                      likesCount:
                        type: integer
                        example: 0
                      releaseForms:
                        type: array
                        example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999767
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4997
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Stories
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Stored Shared Tracking Links (/api-reference/stored-shared-tracking-links/list-stored-shared-tracking-links)

List all shared Tracking Links from the OnlyFansAPI Cache. This is a free endpoint that does not call the OnlyFans API.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/stored/shared-tracking-links
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/stored/shared-tracking-links:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Stored Shared Tracking Links
      operationId: listStoredSharedTrackingLinks
      description: List all shared Tracking Links from the OnlyFansAPI Cache. This is
        a free endpoint that does not call the OnlyFans API.
      parameters:
        - in: query
          name: limit
          description: The number of shared tracking links to return. Default `10`. Must
            be at least 1. Must not be greater than 1000.
          example: 10
          required: false
          schema:
            type: integer
            description: The number of shared tracking links to return. Default `10`. Must
              be at least 1. Must not be greater than 1000.
            example: 10
        - in: query
          name: offset
          description: The offset used for pagination. Default `0`. Must be at least 0.
          example: 0
          required: false
          schema:
            type: integer
            description: The offset used for pagination. Default `0`. Must be at least 0.
            example: 0
        - in: query
          name: filter
          description: ""
          example: []
          required: false
          schema:
            type: object
            description: ""
            example: []
            properties: {}
        - in: query
          name: filter.search
          description: Must not be greater than 255 characters.
          example: ssanzeorkytxzfovnstdmz
          required: false
          schema:
            type: string
            description: Must not be greater than 255 characters.
            example: ssanzeorkytxzfovnstdmz
            nullable: true
        - in: query
          name: filter.tags
          description: Must not be greater than 50 characters.
          example:
            - mqzcaowotcfzqcnkonnzbi
          required: false
          schema:
            type: array
            description: Must not be greater than 50 characters.
            example:
              - mqzcaowotcfzqcnkonnzbi
            items:
              type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - id: 123
                        campaignCode: 123
                        campaignName: Example tracking link
                        campaignUrl: https://onlyfans.com/USERNAME/c123
                        subscribersCount: 123
                        clicksCount: 123
                        createdAt: 2025-01-01T00:00:00+00:00
                        endDate: null
                        isDeleted: false
                        tags: []
                        owner:
                          id: 123
                          username: username
                          name: Model name
                          avatarThumbUrl: https://thumbs.onlyfans.com/public/files/thumbs/a123/a/aa/aaa/abc123/123/avatar.jpg
                    hasMore: false
                  _pagination:
                    next_page: null
                    notice: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 10055833
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - id: 123
                            campaignCode: 123
                            campaignName: Example tracking link
                            campaignUrl: https://onlyfans.com/USERNAME/c123
                            subscribersCount: 123
                            clicksCount: 123
                            createdAt: 2025-01-01T00:00:00+00:00
                            endDate: null
                            isDeleted: false
                            tags: []
                            owner:
                              id: 123
                              username: username
                              name: Model name
                              avatarThumbUrl: https://thumbs.onlyfans.com/public/files/thumbs/a123/a/aa/aaa/abc123/123/avatar.jpg
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            campaignCode:
                              type: integer
                              example: 123
                            campaignName:
                              type: string
                              example: Example tracking link
                            campaignUrl:
                              type: string
                              example: https://onlyfans.com/USERNAME/c123
                            subscribersCount:
                              type: integer
                              example: 123
                            clicksCount:
                              type: integer
                              example: 123
                            createdAt:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            endDate:
                              type: string
                              example: null
                              nullable: true
                            isDeleted:
                              type: boolean
                              example: false
                            tags:
                              type: array
                              example: []
                            owner:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                username:
                                  type: string
                                  example: username
                                name:
                                  type: string
                                  example: Model name
                                avatarThumbUrl:
                                  type: string
                                  example: https://thumbs.onlyfans.com/public/files/thumbs/a123/a/aa/aaa/abc123/123/avatar.jpg
                      hasMore:
                        type: boolean
                        example: false
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: null
                        nullable: true
                      notice:
                        type: string
                        example: null
                        nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 10055833
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Stored Shared Tracking Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Add Story to Highlight (/api-reference/story-highlights/add-story-to-highlight)

Add a specific story to a story highlight.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml patch /api/{account}/stories/highlights/{highlight_id}/{story_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/stories/highlights/{highlight_id}/{story_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: highlight_id
        description: The ID of the story highlight to add the story to
        example: 1234567890
        required: true
        schema:
          type: integer
      - in: path
        name: story_id
        description: The ID of the story.
        example: voluptas
        required: true
        schema:
          type: string
    patch:
      summary: Add Story to Highlight
      operationId: addStoryToHighlight
      description: Add a specific story to a story highlight.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999728
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999728
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Story Highlights
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                story_id:
                  type: integer
                  description: The ID of the story to add to the highlight
                  example: 2345678901
              required:
                - story_id
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Create Story Highlight (/api-reference/story-highlights/create-story-highlight)

Create a new story highlight.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/stories/highlights
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/stories/highlights:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Create Story Highlight
      operationId: createStoryHighlight
      description: Create a new story highlight.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    userId: 123
                    title: title
                    coverStoryId: 123
                    cover: https://cdn2.onlyfans.com/files/...
                    storiesCount: 1
                    createdAt: 2025-01-01T01:01:01+00:00
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999735
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      userId:
                        type: integer
                        example: 123
                      title:
                        type: string
                        example: title
                      coverStoryId:
                        type: integer
                        example: 123
                      cover:
                        type: string
                        example: https://cdn2.onlyfans.com/files/...
                      storiesCount:
                        type: integer
                        example: 1
                      createdAt:
                        type: string
                        example: 2025-01-01T01:01:01+00:00
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999735
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Story Highlights
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  description: The title of the story highlight
                  example: My Highlight
                coverStoryId:
                  type: integer
                  description: The ID of the story to use as the cover for the highlight
                  example: 9876543210
                storyIds:
                  type: array
                  description: An array of story IDs to include in the highlight
                  example:
                    - 1234567890
                    - 2345678901
                  items:
                    type: string
              required:
                - title
                - coverStoryId
                - storyIds
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Delete Story Highlight (/api-reference/story-highlights/delete-story-highlight)

Delete a specific story highlight by its ID.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/stories/highlights/{highlight_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/stories/highlights/{highlight_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: highlight_id
        description: The ID of the story highlight to retrieve
        example: 1234567890
        required: true
        schema:
          type: integer
    delete:
      summary: Delete Story Highlight
      operationId: deleteStoryHighlight
      description: Delete a specific story highlight by its ID.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999736
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4998
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999736
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4998
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Story Highlights
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Story Highlights (/api-reference/story-highlights/list-story-highlights)

Retrieve a list of your story highlights.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/stories/highlights
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/stories/highlights:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Story Highlights
      operationId: listStoryHighlights
      description: Retrieve a list of your story highlights.
      parameters:
        - in: query
          name: limit
          description: Number of highlights to return (default = 5)
          example: 5
          required: false
          schema:
            type: integer
            description: Number of highlights to return (default = 5)
            example: 5
        - in: query
          name: offset
          description: Number of highlights to skip for pagination
          example: 0
          required: false
          schema:
            type: integer
            description: Number of highlights to skip for pagination
            example: 0
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - id: 123
                        userId: 123
                        title: title
                        coverStoryId: 123
                        cover: https://cdn2.onlyfans.com/files/...
                        storiesCount: 1
                        createdAt: 2025-01-01T01:01:01+00:00
                    hasMore: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999744
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - id: 123
                            userId: 123
                            title: title
                            coverStoryId: 123
                            cover: https://cdn2.onlyfans.com/files/...
                            storiesCount: 1
                            createdAt: 2025-01-01T01:01:01+00:00
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            userId:
                              type: integer
                              example: 123
                            title:
                              type: string
                              example: title
                            coverStoryId:
                              type: integer
                              example: 123
                            cover:
                              type: string
                              example: https://cdn2.onlyfans.com/files/...
                            storiesCount:
                              type: integer
                              example: 1
                            createdAt:
                              type: string
                              example: 2025-01-01T01:01:01+00:00
                      hasMore:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999744
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Story Highlights
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Remove Story from Highlight (/api-reference/story-highlights/remove-story-from-highlight)

Remove a specific story from a story highlight.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/stories/highlights/{highlight_id}/{story_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/stories/highlights/{highlight_id}/{story_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: highlight_id
        description: The ID of the story highlight to add the story to
        example: 1234567890
        required: true
        schema:
          type: integer
      - in: path
        name: story_id
        description: The ID of the story.
        example: voluptas
        required: true
        schema:
          type: string
    delete:
      summary: Remove Story from Highlight
      operationId: removeStoryFromHighlight
      description: Remove a specific story from a story highlight.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999729
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4998
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999729
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4998
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Story Highlights
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Show Story Highlight (/api-reference/story-highlights/show-story-highlight)

Retrieve details of a specific story highlight by its ID.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/stories/highlights/{highlight_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/stories/highlights/{highlight_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: highlight_id
        description: The ID of the story highlight to retrieve
        example: 1234567890
        required: true
        schema:
          type: integer
    get:
      summary: Show Story Highlight
      operationId: showStoryHighlight
      description: Retrieve details of a specific story highlight by its ID.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    userId: 123
                    title: title
                    coverStoryId: 123
                    cover: https://cdn2.onlyfans.com/files/...
                    storiesCount: 1
                    createdAt: 2025-01-01T01:01:01+00:00
                    stories:
                      - id: 123
                        userId: 123
                        isReady: true
                        hasPost: false
                        isWatched: true
                        media:
                          - id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: 2025-01-01T01:01:01+00:00
                            isReady: true
                            files:
                              full:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 1150
                                height: 760
                                size: 0
                                sources: []
                              thumb:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 960
                                height: 635
                                size: 0
                                sources:
                                  w150: https://cdn2.onlyfans.com/files/...
                              squarePreview:
                                url: https://cdn2.onlyfans.com/files/...
                                width: 960
                                height: 960
                                size: 0
                                sources:
                                  w150: https://thumbs.onlyfans.com/...
                                  w480: https://thumbs.onlyfans.com/...
                            duration: 0
                            hasCustomPreview: false
                            videoSources:
                              "240": null
                              "720": null
                        createdAt: 2025-01-01T01:01:01+00:00
                        canvasHeight: 760
                        canvasWidth: 1150
                        question: null
                        texts:
                          - text: text
                            type: text
                            users: []
                            scale: 1.7996870109546
                            textAlign: left
                            textWidth: 242.23787167449
                            textHeight: 108.15055734597
                            color: "#ffffff"
                            bgColor: "#ff51dc"
                            fontFamily: Roboto
                            fontStyle: null
                            fontWeight: 400
                            top: 42.88483175
                            left: 39.46791862
                            angle: 0
                            fontSize: 19.88px
                            zIndex: 3
                        viewersCount: 0
                        viewers: []
                        commentsCount: 0
                        canDelete: true
                        isHighlightCover: true
                        isLastInHighlight: true
                        tipsAmount: $0
                        tipsAmountRaw: 0
                        tipsCount: 0
                        likesCount: 0
                        releaseForms: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999741
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4997
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      userId:
                        type: integer
                        example: 123
                      title:
                        type: string
                        example: title
                      coverStoryId:
                        type: integer
                        example: 123
                      cover:
                        type: string
                        example: https://cdn2.onlyfans.com/files/...
                      storiesCount:
                        type: integer
                        example: 1
                      createdAt:
                        type: string
                        example: 2025-01-01T01:01:01+00:00
                      stories:
                        type: array
                        example:
                          - id: 123
                            userId: 123
                            isReady: true
                            hasPost: false
                            isWatched: true
                            media:
                              - id: 123
                                type: photo
                                convertedToVideo: false
                                canView: true
                                hasError: false
                                createdAt: 2025-01-01T01:01:01+00:00
                                isReady: true
                                files:
                                  full:
                                    url: https://cdn2.onlyfans.com/files/...
                                    width: 1150
                                    height: 760
                                    size: 0
                                    sources: []
                                  thumb:
                                    url: https://cdn2.onlyfans.com/files/...
                                    width: 300
                                    height: 300
                                    size: 0
                                  preview:
                                    url: https://cdn2.onlyfans.com/files/...
                                    width: 960
                                    height: 635
                                    size: 0
                                    sources:
                                      w150: https://cdn2.onlyfans.com/files/...
                                  squarePreview:
                                    url: https://cdn2.onlyfans.com/files/...
                                    width: 960
                                    height: 960
                                    size: 0
                                    sources:
                                      w150: https://thumbs.onlyfans.com/...
                                      w480: https://thumbs.onlyfans.com/...
                                duration: 0
                                hasCustomPreview: false
                                videoSources:
                                  "240": null
                                  "720": null
                            createdAt: 2025-01-01T01:01:01+00:00
                            canvasHeight: 760
                            canvasWidth: 1150
                            question: null
                            texts:
                              - text: text
                                type: text
                                users: []
                                scale: 1.7996870109546
                                textAlign: left
                                textWidth: 242.23787167449
                                textHeight: 108.15055734597
                                color: "#ffffff"
                                bgColor: "#ff51dc"
                                fontFamily: Roboto
                                fontStyle: null
                                fontWeight: 400
                                top: 42.88483175
                                left: 39.46791862
                                angle: 0
                                fontSize: 19.88px
                                zIndex: 3
                            viewersCount: 0
                            viewers: []
                            commentsCount: 0
                            canDelete: true
                            isHighlightCover: true
                            isLastInHighlight: true
                            tipsAmount: $0
                            tipsAmountRaw: 0
                            tipsCount: 0
                            likesCount: 0
                            releaseForms: []
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            userId:
                              type: integer
                              example: 123
                            isReady:
                              type: boolean
                              example: true
                            hasPost:
                              type: boolean
                              example: false
                            isWatched:
                              type: boolean
                              example: true
                            media:
                              type: array
                              example:
                                - id: 123
                                  type: photo
                                  convertedToVideo: false
                                  canView: true
                                  hasError: false
                                  createdAt: 2025-01-01T01:01:01+00:00
                                  isReady: true
                                  files:
                                    full:
                                      url: https://cdn2.onlyfans.com/files/...
                                      width: 1150
                                      height: 760
                                      size: 0
                                      sources: []
                                    thumb:
                                      url: https://cdn2.onlyfans.com/files/...
                                      width: 300
                                      height: 300
                                      size: 0
                                    preview:
                                      url: https://cdn2.onlyfans.com/files/...
                                      width: 960
                                      height: 635
                                      size: 0
                                      sources:
                                        w150: https://cdn2.onlyfans.com/files/...
                                    squarePreview:
                                      url: https://cdn2.onlyfans.com/files/...
                                      width: 960
                                      height: 960
                                      size: 0
                                      sources:
                                        w150: https://thumbs.onlyfans.com/...
                                        w480: https://thumbs.onlyfans.com/...
                                  duration: 0
                                  hasCustomPreview: false
                                  videoSources:
                                    "240": null
                                    "720": null
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  type:
                                    type: string
                                    example: photo
                                  convertedToVideo:
                                    type: boolean
                                    example: false
                                  canView:
                                    type: boolean
                                    example: true
                                  hasError:
                                    type: boolean
                                    example: false
                                  createdAt:
                                    type: string
                                    example: 2025-01-01T01:01:01+00:00
                                  isReady:
                                    type: boolean
                                    example: true
                                  files:
                                    type: object
                                    properties:
                                      full:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                            example: https://cdn2.onlyfans.com/files/...
                                          width:
                                            type: integer
                                            example: 1150
                                          height:
                                            type: integer
                                            example: 760
                                          size:
                                            type: integer
                                            example: 0
                                          sources:
                                            type: array
                                            example: []
                                      thumb:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                            example: https://cdn2.onlyfans.com/files/...
                                          width:
                                            type: integer
                                            example: 300
                                          height:
                                            type: integer
                                            example: 300
                                          size:
                                            type: integer
                                            example: 0
                                      preview:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                            example: https://cdn2.onlyfans.com/files/...
                                          width:
                                            type: integer
                                            example: 960
                                          height:
                                            type: integer
                                            example: 635
                                          size:
                                            type: integer
                                            example: 0
                                          sources:
                                            type: object
                                            properties:
                                              w150:
                                                type: string
                                                example: https://cdn2.onlyfans.com/files/...
                                      squarePreview:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                            example: https://cdn2.onlyfans.com/files/...
                                          width:
                                            type: integer
                                            example: 960
                                          height:
                                            type: integer
                                            example: 960
                                          size:
                                            type: integer
                                            example: 0
                                          sources:
                                            type: object
                                            properties:
                                              w150:
                                                type: string
                                                example: https://thumbs.onlyfans.com/...
                                              w480:
                                                type: string
                                                example: https://thumbs.onlyfans.com/...
                                  duration:
                                    type: integer
                                    example: 0
                                  hasCustomPreview:
                                    type: boolean
                                    example: false
                                  videoSources:
                                    type: object
                                    properties:
                                      "240":
                                        type: string
                                        example: null
                                        nullable: true
                                      "720":
                                        type: string
                                        example: null
                                        nullable: true
                            createdAt:
                              type: string
                              example: 2025-01-01T01:01:01+00:00
                            canvasHeight:
                              type: integer
                              example: 760
                            canvasWidth:
                              type: integer
                              example: 1150
                            question:
                              type: string
                              example: null
                              nullable: true
                            texts:
                              type: array
                              example:
                                - text: text
                                  type: text
                                  users: []
                                  scale: 1.7996870109546
                                  textAlign: left
                                  textWidth: 242.23787167449
                                  textHeight: 108.15055734597
                                  color: "#ffffff"
                                  bgColor: "#ff51dc"
                                  fontFamily: Roboto
                                  fontStyle: null
                                  fontWeight: 400
                                  top: 42.88483175
                                  left: 39.46791862
                                  angle: 0
                                  fontSize: 19.88px
                                  zIndex: 3
                              items:
                                type: object
                                properties:
                                  text:
                                    type: string
                                    example: text
                                  type:
                                    type: string
                                    example: text
                                  users:
                                    type: array
                                    example: []
                                  scale:
                                    type: number
                                    example: 1.7996870109546
                                  textAlign:
                                    type: string
                                    example: left
                                  textWidth:
                                    type: number
                                    example: 242.23787167449
                                  textHeight:
                                    type: number
                                    example: 108.15055734597
                                  color:
                                    type: string
                                    example: "#ffffff"
                                  bgColor:
                                    type: string
                                    example: "#ff51dc"
                                  fontFamily:
                                    type: string
                                    example: Roboto
                                  fontStyle:
                                    type: string
                                    example: null
                                    nullable: true
                                  fontWeight:
                                    type: integer
                                    example: 400
                                  top:
                                    type: number
                                    example: 42.88483175
                                  left:
                                    type: number
                                    example: 39.46791862
                                  angle:
                                    type: integer
                                    example: 0
                                  fontSize:
                                    type: string
                                    example: 19.88px
                                  zIndex:
                                    type: integer
                                    example: 3
                            viewersCount:
                              type: integer
                              example: 0
                            viewers:
                              type: array
                              example: []
                            commentsCount:
                              type: integer
                              example: 0
                            canDelete:
                              type: boolean
                              example: true
                            isHighlightCover:
                              type: boolean
                              example: true
                            isLastInHighlight:
                              type: boolean
                              example: true
                            tipsAmount:
                              type: string
                              example: $0
                            tipsAmountRaw:
                              type: integer
                              example: 0
                            tipsCount:
                              type: integer
                              example: 0
                            likesCount:
                              type: integer
                              example: 0
                            releaseForms:
                              type: array
                              example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999741
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4997
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Story Highlights
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Update Story Highlight (/api-reference/story-highlights/update-story-highlight)

Update the details of a specific story highlight by its ID.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml put /api/{account}/stories/highlights/{highlight_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/stories/highlights/{highlight_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: highlight_id
        description: The ID of the story highlight to retrieve
        example: 1234567890
        required: true
        schema:
          type: integer
    put:
      summary: Update Story Highlight
      operationId: updateStoryHighlight
      description: Update the details of a specific story highlight by its ID.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    userId: 132
                    title: title
                    coverStoryId: 123
                    cover: https://cdn2.onlyfans.com/files/...
                    storiesCount: 2
                    createdAt: 2025-01-01T01:01:01+00:00
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999738
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4996
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      userId:
                        type: integer
                        example: 132
                      title:
                        type: string
                        example: title
                      coverStoryId:
                        type: integer
                        example: 123
                      cover:
                        type: string
                        example: https://cdn2.onlyfans.com/files/...
                      storiesCount:
                        type: integer
                        example: 2
                      createdAt:
                        type: string
                        example: 2025-01-01T01:01:01+00:00
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999738
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4996
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Story Highlights
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  description: The new title for the story highlight. Provide the old value if you
                    don't want to change it.
                  example: My Updated Highlight
                coverStoryId:
                  type: integer
                  description: The ID of the story to use as the cover for the highlight. Provide
                    the old value if you don't want to change it.
                  example: 9876543210
                storyIds:
                  type: array
                  description: An array of story IDs to include in the highlight. Provide the old
                    value if you don't want to change it.
                  example:
                    - 1234567890
                    - 2345678901
                  items:
                    type: string
              required:
                - title
                - coverStoryId
                - storyIds
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Create Bundle (/api-reference/subscription-bundles/create-bundle)

Create a new bundle for the account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/bundles
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/bundles:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Create Bundle
      operationId: createBundle
      description: Create a new bundle for the account.
      parameters:
        - in: query
          name: discount
          description: The bundle's discount percentage.
          example: 10
          required: true
          schema:
            type: integer
            description: The bundle's discount percentage.
            example: 10
            enum:
              - 0
              - 5
              - 10
              - 15
              - 20
              - 25
              - 30
              - 35
              - 40
              - 45
              - 50
        - in: query
          name: duration
          description: The bundle's duration in months.
          example: 10
          required: true
          schema:
            type: integer
            description: The bundle's duration in months.
            example: 10
            enum:
              - 3
              - 6
              - 12
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    discount: 15
                    duration: 12
                    price: 123
                    canBuy: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999813
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: null
                      remaining_minute: 996
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      discount:
                        type: integer
                        example: 15
                      duration:
                        type: integer
                        example: 12
                      price:
                        type: integer
                        example: 123
                      canBuy:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999813
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 996
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Subscription Bundles
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Delete Bundle (/api-reference/subscription-bundles/delete-bundle)

Delete a bundle for the account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/bundles/{bundle_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/bundles/{bundle_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: bundle_id
        description: The ID of the bundle to delete.
        example: 123
        required: true
        schema:
          type: string
    delete:
      summary: Delete Bundle
      operationId: deleteBundle
      description: Delete a bundle for the account.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    discount: 15
                    duration: 12
                    price: 123
                    canBuy: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999813
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: null
                      remaining_minute: 996
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      discount:
                        type: integer
                        example: 15
                      duration:
                        type: integer
                        example: 12
                      price:
                        type: integer
                        example: 123
                      canBuy:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999813
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 996
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Subscription Bundles
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Bundles (/api-reference/subscription-bundles/list-bundles)

List all bundles for the account.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/bundles
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/bundles:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Bundles
      operationId: listBundles
      description: List all bundles for the account.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - id: 123
                      discount: 15
                      duration: 12
                      price: 123
                      canBuy: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999814
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: null
                      remaining_minute: 999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: array
                    example:
                      - id: 123
                        discount: 15
                        duration: 12
                        price: 123
                        canBuy: false
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 123
                        discount:
                          type: integer
                          example: 15
                        duration:
                          type: integer
                          example: 12
                        price:
                          type: integer
                          example: 123
                        canBuy:
                          type: boolean
                          example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999814
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Subscription Bundles
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Transactions (/api-reference/transactions/list-transactions)

Get a paginated list of transactions for an Account. Newest transactions are first. You can filter by transaction type and tips source.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/transactions
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/transactions:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Transactions
      operationId: listTransactions
      description: Get a paginated list of transactions for an Account. Newest
        transactions are first. You can filter by transaction type and tips
        source.
      parameters:
        - in: query
          name: limit
          description: "The number of transactions to return. Recommended: `10`"
          example: 10
          required: false
          schema:
            type: string
            description: "The number of transactions to return. Recommended: `10`"
            example: 10
        - in: query
          name: startDate
          description: The start date for the transactions list. Defaults to 30 days ago.
          example: 2025-01-01 00:00:00
          required: false
          schema:
            type: string
            description: The start date for the transactions list. Defaults to 30 days ago.
            example: 2025-01-01 00:00:00
        - in: query
          name: marker
          description: "The marker used for pagination. Default: `null`"
          example: "1739155047"
          required: false
          schema:
            type: string
            description: "The marker used for pagination. Default: `null`"
            example: "1739155047"
        - in: query
          name: type
          description: "Filter by transaction type. Options: `subscribes`, `tips`, `post`,
            `chat_messages`, `stream`"
          example: tips
          required: false
          schema:
            type: string
            description: "Filter by transaction type. Options: `subscribes`, `tips`, `post`,
              `chat_messages`, `stream`"
            example: tips
        - in: query
          name: tipsSource
          description: "Filter tips by source. Only applies when `type=tips`. Options:
            `profile`, `post_all`, `chat`, `stream`, `story`"
          example: post_all
          required: false
          schema:
            type: string
            description: "Filter tips by source. Only applies when `type=tips`. Options:
              `profile`, `post_all`, `chat`, `stream`, `story`"
            example: post_all
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - amount: 19.99
                        vatAmount: 0
                        taxAmount: 0
                        net: 15.99
                        fee: 4
                        createdAt: 2025-02-10T02:51:22+00:00
                        currency: USD
                        description: Payment for message from <a
                          href="https://onlyfans.com/XXXXXXXX">XXXXXXXX</a>
                        status: loading
                        user:
                          view: t
                          id: 123123123
                          name: Michael XXXXXXXX
                          username: u123123123
                          isVerified: false
                          avatar: https://public.onlyfans.com/files/XXXXXXXXXX.jpg
                          avatarThumbs:
                            c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/XXXXXXXXXX.jpg
                            c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/XXXXXXXXXX.jpg
                        payoutPendingDays: 7
                        id: 5XXXXXXXXXaa1aXXXXXXXXXXX
                        type: message
                    marker: 1739156703
                    hasMore: true
                    nextMarker: 1739155047
                  _pagination:
                    next_page: https://app.onlyfansapi.com/api/acct_XXXXXXXX/transactions?startDate=-30days&marker=1739155047&
                  _meta:
                    _credits:
                      used: 1
                      balance: 34
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 990
                      remaining_day: 49977
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - amount: 19.99
                            vatAmount: 0
                            taxAmount: 0
                            net: 15.99
                            fee: 4
                            createdAt: 2025-02-10T02:51:22+00:00
                            currency: USD
                            description: Payment for message from <a
                              href="https://onlyfans.com/XXXXXXXX">XXXXXXXX</a>
                            status: loading
                            user:
                              view: t
                              id: 123123123
                              name: Michael XXXXXXXX
                              username: u123123123
                              isVerified: false
                              avatar: https://public.onlyfans.com/files/XXXXXXXXXX.jpg
                              avatarThumbs:
                                c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/XXXXXXXXXX.jpg
                                c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/XXXXXXXXXX.jpg
                            payoutPendingDays: 7
                            id: 5XXXXXXXXXaa1aXXXXXXXXXXX
                            type: message
                        items:
                          type: object
                          properties:
                            amount:
                              type: number
                              example: 19.99
                            vatAmount:
                              type: integer
                              example: 0
                            taxAmount:
                              type: integer
                              example: 0
                            net:
                              type: number
                              example: 15.99
                            fee:
                              type: integer
                              example: 4
                            createdAt:
                              type: string
                              example: 2025-02-10T02:51:22+00:00
                            currency:
                              type: string
                              example: USD
                            description:
                              type: string
                              example: Payment for message from <a
                                href="https://onlyfans.com/XXXXXXXX">XXXXXXXX</a>
                            status:
                              type: string
                              example: loading
                            user:
                              type: object
                              properties:
                                view:
                                  type: string
                                  example: t
                                id:
                                  type: integer
                                  example: 123123123
                                name:
                                  type: string
                                  example: Michael XXXXXXXX
                                username:
                                  type: string
                                  example: u123123123
                                isVerified:
                                  type: boolean
                                  example: false
                                avatar:
                                  type: string
                                  example: https://public.onlyfans.com/files/XXXXXXXXXX.jpg
                                avatarThumbs:
                                  type: object
                                  properties:
                                    c50:
                                      type: string
                                      example: https://thumbs.onlyfans.com/public/files/thumbs/c50/XXXXXXXXXX.jpg
                                    c144:
                                      type: string
                                      example: https://thumbs.onlyfans.com/public/files/thumbs/c144/XXXXXXXXXX.jpg
                            payoutPendingDays:
                              type: integer
                              example: 7
                            id:
                              type: string
                              example: 5XXXXXXXXXaa1aXXXXXXXXXXX
                            type:
                              type: string
                              example: message
                      marker:
                        type: integer
                        example: 1739156703
                      hasMore:
                        type: boolean
                        example: true
                      nextMarker:
                        type: integer
                        example: 1739155047
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: https://app.onlyfansapi.com/api/acct_XXXXXXXX/transactions?startDate=-30days&marker=1739155047&
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 34
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 990
                          remaining_day:
                            type: integer
                            example: 49977
      tags:
        - Transactions
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Add Tracking Link Tags (/api-reference/tracking-links/add-tracking-link-tags)

Add tags to a specific tracking link. Existing tags are preserved. This is a free endpoint.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/tracking-links/{tracking_link_id}/tags
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/tracking-links/{tracking_link_id}/tags:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: tracking_link_id
        description: The ID of the tracking link
        example: 123456789
        required: true
        schema:
          type: integer
    post:
      summary: Add Tracking Link Tags
      operationId: addTrackingLinkTags
      description: Add tags to a specific tracking link. Existing tags are preserved.
        This is a free endpoint.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    tags:
                      - Instagram
                      - Twitter
                      - TikTok
                  _meta:
                    _credits:
                      used: 0
                      balance: 9529
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                properties:
                  data:
                    type: object
                    properties:
                      tags:
                        type: array
                        example:
                          - Instagram
                          - Twitter
                          - TikTok
                        items:
                          type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9529
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
      tags:
        - Tracking Links
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tags:
                  type: array
                  description: Array of tag names to add to the tracking link.
                  example: '["Instagram", "Twitter"]'
                  items:
                    type: string
              required:
                - tags
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Create Tracking Link (/api-reference/tracking-links/create-tracking-link)

Create a new Tracking Link for the account

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/tracking-links
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/tracking-links:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    post:
      summary: Create Tracking Link
      operationId: createTrackingLink
      description: Create a new Tracking Link for the account
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - id: 123
                      countSubscribers: 0
                      countTransitions: 0
                      campaignCode: 123
                      campaignName: foobar
                      createdAt: 2025-01-01T00:00:00+00:00
                      endDate: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999985
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999998
                      remaining_day: 49988
                properties:
                  data:
                    type: array
                    example:
                      - id: 123
                        countSubscribers: 0
                        countTransitions: 0
                        campaignCode: 123
                        campaignName: foobar
                        createdAt: 2025-01-01T00:00:00+00:00
                        endDate: null
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 123
                        countSubscribers:
                          type: integer
                          example: 0
                        countTransitions:
                          type: integer
                          example: 0
                        campaignCode:
                          type: integer
                          example: 123
                        campaignName:
                          type: string
                          example: foobar
                        createdAt:
                          type: string
                          example: 2025-01-01T00:00:00+00:00
                        endDate:
                          type: string
                          example: null
                          nullable: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999985
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999998
                          remaining_day:
                            type: integer
                            example: 49988
      tags:
        - Tracking Links
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tags:
                  type: array
                  description: Array of tag names to add to the tracking link.
                  example: '["Instagram", "Twitter"]'
                  items:
                    type: string
                name:
                  type: string
                  description: The name of the Tracking Link
                  example: Twitter bio
              required:
                - name
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Delete Tracking Link (/api-reference/tracking-links/delete-tracking-link)

Delete a Tracking Link

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/tracking-links/{tracking_link_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/tracking-links/{tracking_link_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: tracking_link_id
        description: The ID of the tracking link.
        example: iste
        required: true
        schema:
          type: string
    delete:
      summary: Delete Tracking Link
      operationId: deleteTrackingLink
      description: Delete a Tracking Link
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999986
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999997
                      remaining_day: 49990
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999986
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999997
                          remaining_day:
                            type: integer
                            example: 49990
      tags:
        - Tracking Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Tracking Link Cohort ARPS (/api-reference/tracking-links/get-tracking-link-cohort-arps)

Get per-link time-to-profit cohort ARPS windows for a specific Tracking Link

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/tracking-links/{tracking_link_id}/cohort-arps
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/tracking-links/{tracking_link_id}/cohort-arps:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: tracking_link_id
        description: The ID of the tracking link.
        example: ut
        required: true
        schema:
          type: string
    get:
      summary: Get Tracking Link Cohort ARPS
      operationId: getTrackingLinkCohortARPS
      description: Get per-link time-to-profit cohort ARPS windows for a specific
        Tracking Link
      parameters:
        - in: query
          name: acquisition_start
          description: Optional acquisition range start date
          example: 2026-01-01T00:00:00Z
          required: false
          schema:
            type: string
            description: Optional acquisition range start date
            example: 2026-01-01T00:00:00Z
        - in: query
          name: acquisition_end
          description: Optional acquisition range end date
          example: 2026-01-31T23:59:59Z
          required: false
          schema:
            type: string
            description: Optional acquisition range end date
            example: 2026-01-31T23:59:59Z
        - in: query
          name: revenue_basis
          description: Revenue basis. Defaults to `net`.
          example: net
          required: false
          schema:
            type: string
            description: Revenue basis. Defaults to `net`.
            example: net
            enum:
              - net
              - gross
      responses:
        "401":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  error: Unauthorized. Go to https://app.onlyfansapi.com/api-keys to get your API
                    key.
                properties:
                  error:
                    type: string
                    example: Unauthorized. Go to https://app.onlyfansapi.com/api-keys to get your
                      API key.
      tags:
        - Tracking Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Tracking Link Stats (/api-reference/tracking-links/get-tracking-link-stats)

Get dashboard-style summary plus daily and monthly metrics for a specific Tracking Link.

<Callout title="Important information">
  * `daily_metrics` returns **incremental per-day values**, not cumulative totals.
  * Cumulative totals are available in the `summary` section.
  * Historical daily data is only available from when we began recording daily link stats.
  * Daily data can only be tracked from the date the account was connected to OnlyFans API; earlier periods are not available.
</Callout>

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/tracking-links/{tracking_link_id}/stats
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/tracking-links/{tracking_link_id}/stats:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: tracking_link_id
        description: The ID of the tracking link.
        example: ab
        required: true
        schema:
          type: string
    get:
      summary: Get Tracking Link Stats
      operationId: getTrackingLinkStats
      description: "

        \          Get dashboard-style summary plus daily and monthly metrics
        for a specific Tracking Link.

        \          <Callout title='Important information'>

        \            - `daily_metrics` returns **incremental per-day values**,
        not cumulative totals.

        \            - Cumulative totals are available in the `summary` section.

        \            - Historical daily data is only available from when we
        began recording daily link stats.

        \            - Daily data can only be tracked from the date the account
        was connected to OnlyFans API; earlier periods are not available.

        \          </Callout>

        \        "
      parameters:
        - in: query
          name: date_start
          description: Optional stats range start date
          example: 2026-01-01T00:00:00Z
          required: false
          schema:
            type: string
            description: Optional stats range start date
            example: 2026-01-01T00:00:00Z
        - in: query
          name: date_end
          description: Optional stats range end date
          example: 2026-01-31T23:59:59Z
          required: false
          schema:
            type: string
            description: Optional stats range end date
            example: 2026-01-31T23:59:59Z
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    summary:
                      clicks_total: 320
                      subs_total: 80
                      revenue_total: 240.5
                      spenders_total: 22
                      revenue_cached_at: 2026-01-31T23:59:59+00:00
                    daily_metrics:
                      - timestamp: 2026-01-30
                        clicks: 12
                        subs: 2
                        revenue: 9.5
                        spenders: 1
                      - timestamp: 2026-01-31
                        clicks: 17
                        subs: 3
                        revenue: 14
                        spenders: 2
                    monthly_metrics:
                      - timestamp: 2026-01-01
                        clicks: 320
                        subs: 80
                        revenue: 240.5
                        spenders: 22
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                properties:
                  data:
                    type: object
                    properties:
                      summary:
                        type: object
                        properties:
                          clicks_total:
                            type: integer
                            example: 320
                          subs_total:
                            type: integer
                            example: 80
                          revenue_total:
                            type: number
                            example: 240.5
                          spenders_total:
                            type: integer
                            example: 22
                          revenue_cached_at:
                            type: string
                            example: 2026-01-31T23:59:59+00:00
                      daily_metrics:
                        type: array
                        example:
                          - timestamp: 2026-01-30
                            clicks: 12
                            subs: 2
                            revenue: 9.5
                            spenders: 1
                          - timestamp: 2026-01-31
                            clicks: 17
                            subs: 3
                            revenue: 14
                            spenders: 2
                        items:
                          type: object
                          properties:
                            timestamp:
                              type: string
                              example: 2026-01-30
                            clicks:
                              type: integer
                              example: 12
                            subs:
                              type: integer
                              example: 2
                            revenue:
                              type: number
                              example: 9.5
                            spenders:
                              type: integer
                              example: 1
                      monthly_metrics:
                        type: array
                        example:
                          - timestamp: 2026-01-01
                            clicks: 320
                            subs: 80
                            revenue: 240.5
                            spenders: 22
                        items:
                          type: object
                          properties:
                            timestamp:
                              type: string
                              example: 2026-01-01
                            clicks:
                              type: integer
                              example: 320
                            subs:
                              type: integer
                              example: 80
                            revenue:
                              type: number
                              example: 240.5
                            spenders:
                              type: integer
                              example: 22
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
      tags:
        - Tracking Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get Tracking Link (/api-reference/tracking-links/get-tracking-link)

Get individual Tracking Link details and it's revenue data

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/tracking-links/{tracking_link_id}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/tracking-links/{tracking_link_id}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: tracking_link_id
        description: The ID of the tracking link.
        example: iste
        required: true
        schema:
          type: string
    get:
      summary: Get Tracking Link
      operationId: getTrackingLink
      description: Get individual Tracking Link details and it's revenue data
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123456
                    campaignCode: 123
                    campaignName: Example Campaign - IG Bio SFS
                    campaignUrl: https://onlyfans.com/USERNAME/c123
                    subscribersCount: null
                    clicksCount: null
                    createdAt: 2025-01-01T00:00:00+00:00
                    endDate: null
                    tags:
                      - Instagram
                      - Twitter
                    revenue:
                      total: 20
                      revenuePerSubscriber: 2
                      revenuePerClick: 0.2
                      spendersCount: 1
                      calculatedAt: 2025-01-01T00:00:00+00:00
                      isLoading: false
                    cost:
                      inputMode: null
                      inputValue: null
                      perSub: null
                      perClick: null
                      perPromo: null
                      subscriberSourceCount: 0
                      clickSourceCount: 0
                    links:
                      related:
                        subscribers: http://ofapi.test/api/acct_XXXXXXXX/tracking-links/123456/subscribers
                        spenders: http://ofapi.test/api/acct_XXXXXXXX/tracking-links/123456/spenders
                  _meta:
                    _credits:
                      used: 1
                      balance: 7095558
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4998
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123456
                      campaignCode:
                        type: integer
                        example: 123
                      campaignName:
                        type: string
                        example: Example Campaign - IG Bio SFS
                      campaignUrl:
                        type: string
                        example: https://onlyfans.com/USERNAME/c123
                      subscribersCount:
                        type: string
                        example: null
                        nullable: true
                      clicksCount:
                        type: string
                        example: null
                        nullable: true
                      createdAt:
                        type: string
                        example: 2025-01-01T00:00:00+00:00
                      endDate:
                        type: string
                        example: null
                        nullable: true
                      tags:
                        type: array
                        example:
                          - Instagram
                          - Twitter
                        items:
                          type: string
                      revenue:
                        type: object
                        properties:
                          total:
                            type: integer
                            example: 20
                          revenuePerSubscriber:
                            type: integer
                            example: 2
                          revenuePerClick:
                            type: number
                            example: 0.2
                          spendersCount:
                            type: integer
                            example: 1
                          calculatedAt:
                            type: string
                            example: 2025-01-01T00:00:00+00:00
                          isLoading:
                            type: boolean
                            example: false
                      cost:
                        type: object
                        properties:
                          inputMode:
                            type: string
                            example: null
                            nullable: true
                          inputValue:
                            type: string
                            example: null
                            nullable: true
                          perSub:
                            type: string
                            example: null
                            nullable: true
                          perClick:
                            type: string
                            example: null
                            nullable: true
                          perPromo:
                            type: string
                            example: null
                            nullable: true
                          subscriberSourceCount:
                            type: integer
                            example: 0
                          clickSourceCount:
                            type: integer
                            example: 0
                      links:
                        type: object
                        properties:
                          related:
                            type: object
                            properties:
                              subscribers:
                                type: string
                                example: http://ofapi.test/api/acct_XXXXXXXX/tracking-links/123456/subscribers
                              spenders:
                                type: string
                                example: http://ofapi.test/api/acct_XXXXXXXX/tracking-links/123456/spenders
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 7095558
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4998
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
                          notice:
                            type: string
                            example: We have decided to remove our daily rate limits. Please remove any
                              references to these in your integrations.
      tags:
        - Tracking Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Introduction (/api-reference/tracking-links)

import {
    ChartPieIcon,
    LayersIcon
} from 'lucide-react';

Through our API, you are able to create and manage tracking links, as well as retrieve advanced analytics on their performance, spenders and subscribers.

### A note on our calculation logic \[!toc]

<Cards>
  <Card icon={<LayersIcon className="text-fd-primary" />} title="Link Stacking">
    We take link stacking into account (e.g., multiple tracking links stacked on top of each other) and divide the revenue equally between them.
  </Card>

  <Card icon={<ChartPieIcon className="text-fd-primary" />} title="Spendings">
    We only track the fan’s spending during the period through which they have been subscribed.
  </Card>
</Cards>

# List Tracking Link Spenders (/api-reference/tracking-links/list-tracking-link-spenders)

Get list of spenders who made purchases through a Tracking Link

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/tracking-links/{tracking_link_id}/spenders
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/tracking-links/{tracking_link_id}/spenders:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: tracking_link_id
        description: The ID of the Tracking Link. Can be retrieved from the above store
          and list endpoints.
        example: 1234567890
        required: true
        schema:
          type: string
    get:
      summary: List Tracking Link Spenders
      operationId: listTrackingLinkSpenders
      description: Get list of spenders who made purchases through a Tracking Link
      parameters:
        - in: query
          name: limit
          description: The number of spenders to return per page. Default `50`.
          example: 50
          required: false
          schema:
            type: integer
            description: The number of spenders to return per page. Default `50`.
            example: 50
        - in: query
          name: offset
          description: The offset used for pagination. Default `0`.
          example: 0
          required: false
          schema:
            type: integer
            description: The offset used for pagination. Default `0`.
            example: 0
        - in: query
          name: minSpend
          description: Minimal spend of a fan. Default `1`. Must be at least 1.
          example: 1
          required: false
          schema:
            type: number
            description: Minimal spend of a fan. Default `1`. Must be at least 1.
            example: 1
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - onlyfans_id: "100000001"
                      username: user_001
                      revenue:
                        total: 26.8
                        calculated_at: 2025-09-29T10:47:19.000000Z
                    - onlyfans_id: "100000002"
                      username: user_002
                      revenue:
                        total: 109.88
                        calculated_at: 2025-09-29T10:47:19.000000Z
                    - onlyfans_id: "100000003"
                      username: user_003
                      revenue:
                        total: 32.96
                        calculated_at: 2025-09-29T10:47:19.000000Z
                  _meta:
                    _credits:
                      used: 1
                      balance: 224802
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 994
                      remaining_day: 49929
                properties:
                  data:
                    type: array
                    example:
                      - onlyfans_id: "100000001"
                        username: user_001
                        revenue:
                          total: 26.8
                          calculated_at: 2025-09-29T10:47:19.000000Z
                      - onlyfans_id: "100000002"
                        username: user_002
                        revenue:
                          total: 109.88
                          calculated_at: 2025-09-29T10:47:19.000000Z
                      - onlyfans_id: "100000003"
                        username: user_003
                        revenue:
                          total: 32.96
                          calculated_at: 2025-09-29T10:47:19.000000Z
                    items:
                      type: object
                      properties:
                        onlyfans_id:
                          type: string
                          example: "100000001"
                        username:
                          type: string
                          example: user_001
                        revenue:
                          type: object
                          properties:
                            total:
                              type: number
                              example: 26.8
                            calculated_at:
                              type: string
                              example: 2025-09-29T10:47:19.000000Z
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 224802
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 994
                          remaining_day:
                            type: integer
                            example: 49929
      tags:
        - Tracking Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Tracking Link Subscribers (/api-reference/tracking-links/list-tracking-link-subscribers)

Get list of subscribers who joined through a Tracking Link

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/tracking-links/{tracking_link_id}/subscribers
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/tracking-links/{tracking_link_id}/subscribers:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: tracking_link_id
        description: The ID of the Tracking Link. Can be retrieved from the above store
          and list endpoints.
        example: 1234567890
        required: true
        schema:
          type: string
    get:
      summary: List Tracking Link Subscribers
      operationId: listTrackingLinkSubscribers
      description: Get list of subscribers who joined through a Tracking Link
      parameters:
        - in: query
          name: limit
          description: The number of subscribers to return per page. Default `10`
          example: 10
          required: true
          schema:
            type: integer
            description: The number of subscribers to return per page. Default `10`
            example: 10
        - in: query
          name: offset
          description: The offset used for pagination. Default `0`
          example: 0
          required: true
          schema:
            type: integer
            description: The offset used for pagination. Default `0`
            example: 0
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - view: s
                        avatar: https://example.com/avatar1.jpg
                        avatarThumbs:
                          c50: https://example.com/avatar1_thumb50.jpg
                          c144: https://example.com/avatar1_thumb144.jpg
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 100000001
                        name: User1
                        username: user1
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: false
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: ""
                        notice: ""
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: ""
                        lastSeen: null
                        canReport: false
                      - view: s
                        avatar: null
                        avatarThumbs: null
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 100000002
                        name: User2
                        username: user2
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: false
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: ""
                        notice: ""
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: ""
                        lastSeen: 2025-02-10T19:35:01+00:00
                        canReport: false
                      - view: s
                        avatar: null
                        avatarThumbs: null
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 100000003
                        name: User3
                        username: user3
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: false
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: ""
                        notice: ""
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: 1 day
                        lastSeen: 2025-02-10T17:50:30+00:00
                        canReport: false
                      - view: s
                        avatar: null
                        avatarThumbs: null
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 100000004
                        name: User4
                        username: user4
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: false
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: ""
                        notice: ""
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: 4 days
                        lastSeen: null
                        canReport: false
                      - view: s
                        avatar: null
                        avatarThumbs: null
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 100000005
                        name: User5
                        username: user5
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: false
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: ""
                        notice: ""
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: 4 days
                        lastSeen: null
                        canReport: false
                      - view: s
                        avatar: null
                        avatarThumbs: null
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 100000006
                        name: User6
                        username: user6
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: false
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: ""
                        notice: ""
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: 5 days
                        lastSeen: 2025-02-11T07:21:17+00:00
                        canReport: false
                      - view: s
                        avatar: ""
                        avatarThumbs: null
                        header: ""
                        headerSize: null
                        headerThumbs: null
                        id: 100000007
                        name: Deleted user
                        username: ""
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: false
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 0
                        tipsMinInternal: 0
                        tipsMax: 0
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: null
                        isDeleted: true
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: null
                        subscribedOnExpiredNow: null
                        subscribedOnDuration: null
                        lastSeen: 2025-02-06T04:22:08+00:00
                        canReport: false
                      - view: s
                        avatar: https://example.com/avatar8.jpg
                        avatarThumbs:
                          c50: https://example.com/avatar8_thumb50.jpg
                          c144: https://example.com/avatar8_thumb144.jpg
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 100000008
                        name: User8
                        username: user8
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: false
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: ""
                        notice: ""
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: 6 days
                        lastSeen: 2025-02-07T18:57:15+00:00
                        canReport: false
                      - view: s
                        avatar: null
                        avatarThumbs: null
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 100000009
                        name: User9
                        username: user9
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: false
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: ""
                        notice: ""
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: 9 days
                        lastSeen: null
                        canReport: false
                      - view: s
                        avatar: https://example.com/avatar10.jpg
                        avatarThumbs:
                          c50: https://example.com/avatar10_thumb50.jpg
                          c144: https://example.com/avatar10_thumb144.jpg
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 100000010
                        name: User10
                        username: user10
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: false
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: ""
                        notice: ""
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: 17 days
                        lastSeen: 2025-01-25T03:45:20+00:00
                        canReport: false
                    marker: 1739279385
                    hasMore: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 9990
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49998
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - view: s
                            avatar: https://example.com/avatar1.jpg
                            avatarThumbs:
                              c50: https://example.com/avatar1_thumb50.jpg
                              c144: https://example.com/avatar1_thumb144.jpg
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 100000001
                            name: User1
                            username: user1
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: false
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            displayName: ""
                            notice: ""
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: ""
                            lastSeen: null
                            canReport: false
                          - view: s
                            avatar: null
                            avatarThumbs: null
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 100000002
                            name: User2
                            username: user2
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: false
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            displayName: ""
                            notice: ""
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: ""
                            lastSeen: 2025-02-10T19:35:01+00:00
                            canReport: false
                          - view: s
                            avatar: null
                            avatarThumbs: null
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 100000003
                            name: User3
                            username: user3
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: false
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            displayName: ""
                            notice: ""
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: 1 day
                            lastSeen: 2025-02-10T17:50:30+00:00
                            canReport: false
                          - view: s
                            avatar: null
                            avatarThumbs: null
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 100000004
                            name: User4
                            username: user4
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: false
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            displayName: ""
                            notice: ""
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: 4 days
                            lastSeen: null
                            canReport: false
                          - view: s
                            avatar: null
                            avatarThumbs: null
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 100000005
                            name: User5
                            username: user5
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: false
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            displayName: ""
                            notice: ""
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: 4 days
                            lastSeen: null
                            canReport: false
                          - view: s
                            avatar: null
                            avatarThumbs: null
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 100000006
                            name: User6
                            username: user6
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: false
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            displayName: ""
                            notice: ""
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: 5 days
                            lastSeen: 2025-02-11T07:21:17+00:00
                            canReport: false
                          - view: s
                            avatar: ""
                            avatarThumbs: null
                            header: ""
                            headerSize: null
                            headerThumbs: null
                            id: 100000007
                            name: Deleted user
                            username: ""
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: false
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 0
                            tipsMinInternal: 0
                            tipsMax: 0
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: null
                            isDeleted: true
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: null
                            subscribedOnExpiredNow: null
                            subscribedOnDuration: null
                            lastSeen: 2025-02-06T04:22:08+00:00
                            canReport: false
                          - view: s
                            avatar: https://example.com/avatar8.jpg
                            avatarThumbs:
                              c50: https://example.com/avatar8_thumb50.jpg
                              c144: https://example.com/avatar8_thumb144.jpg
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 100000008
                            name: User8
                            username: user8
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: false
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            displayName: ""
                            notice: ""
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: 6 days
                            lastSeen: 2025-02-07T18:57:15+00:00
                            canReport: false
                          - view: s
                            avatar: null
                            avatarThumbs: null
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 100000009
                            name: User9
                            username: user9
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: false
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            displayName: ""
                            notice: ""
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: 9 days
                            lastSeen: null
                            canReport: false
                          - view: s
                            avatar: https://example.com/avatar10.jpg
                            avatarThumbs:
                              c50: https://example.com/avatar10_thumb50.jpg
                              c144: https://example.com/avatar10_thumb144.jpg
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 100000010
                            name: User10
                            username: user10
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: false
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            displayName: ""
                            notice: ""
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: 17 days
                            lastSeen: 2025-01-25T03:45:20+00:00
                            canReport: false
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: s
                            avatar:
                              type: string
                              example: https://example.com/avatar1.jpg
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: https://example.com/avatar1_thumb50.jpg
                                c144:
                                  type: string
                                  example: https://example.com/avatar1_thumb144.jpg
                            header:
                              type: string
                              example: null
                              nullable: true
                            headerSize:
                              type: string
                              example: null
                              nullable: true
                            headerThumbs:
                              type: string
                              example: null
                              nullable: true
                            id:
                              type: integer
                              example: 100000001
                            name:
                              type: string
                              example: User1
                            username:
                              type: string
                              example: user1
                            canLookStory:
                              type: boolean
                              example: false
                            canCommentStory:
                              type: boolean
                              example: false
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: false
                            canPayInternal:
                              type: boolean
                              example: false
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: false
                            tipsTextEnabled:
                              type: boolean
                              example: true
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: false
                            canAddSubscriber:
                              type: boolean
                              example: false
                            subscribePrice:
                              type: integer
                              example: 0
                            displayName:
                              type: string
                              example: ""
                            notice:
                              type: string
                              example: ""
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: false
                            subscribedByExpire:
                              type: string
                              example: null
                              nullable: true
                            subscribedByExpireDate:
                              type: string
                              example: null
                              nullable: true
                            subscribedByAutoprolong:
                              type: string
                              example: null
                              nullable: true
                            subscribedIsExpiredNow:
                              type: string
                              example: null
                              nullable: true
                            currentSubscribePrice:
                              type: string
                              example: null
                              nullable: true
                            subscribedOn:
                              type: boolean
                              example: true
                            subscribedOnExpiredNow:
                              type: boolean
                              example: false
                            subscribedOnDuration:
                              type: string
                              example: ""
                            lastSeen:
                              type: string
                              example: null
                              nullable: true
                            canReport:
                              type: boolean
                              example: false
                      marker:
                        type: integer
                        example: 1739279385
                      hasMore:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 9990
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49998
      tags:
        - Tracking Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Tracking Link Tags (/api-reference/tracking-links/list-tracking-link-tags)

Get tags for a specific tracking link. This is a free endpoint.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/tracking-links/{tracking_link_id}/tags
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/tracking-links/{tracking_link_id}/tags:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: tracking_link_id
        description: The ID of the tracking link
        example: 123456789
        required: true
        schema:
          type: integer
    get:
      summary: List Tracking Link Tags
      operationId: listTrackingLinkTags
      description: Get tags for a specific tracking link. This is a free endpoint.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    tags:
                      - Instagram
                      - Twitter
                  _meta:
                    _credits:
                      used: 0
                      balance: 9529
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                properties:
                  data:
                    type: object
                    properties:
                      tags:
                        type: array
                        example:
                          - Instagram
                          - Twitter
                        items:
                          type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9529
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
      tags:
        - Tracking Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# List Tracking Links (/api-reference/tracking-links/list-tracking-links)

List all tracking links for the account and revenue data

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/tracking-links
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/tracking-links:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: List Tracking Links
      operationId: listTrackingLinks
      description: List all tracking links for the account and revenue data
      parameters:
        - in: query
          name: startDate
          description: The start date for tracking links. Keep empty to get all. Must not
            be greater than 255 characters.
          example: 2025-01-01 00:00:00
          required: false
          schema:
            type: string
            description: The start date for tracking links. Keep empty to get all. Must not
              be greater than 255 characters.
            example: 2025-01-01 00:00:00
            nullable: true
        - in: query
          name: endDate
          description: The end date for tracking links. Keep empty to get all. Must not be
            greater than 255 characters.
          example: 2025-01-31 23:59:59
          required: false
          schema:
            type: string
            description: The end date for tracking links. Keep empty to get all. Must not be
              greater than 255 characters.
            example: 2025-01-31 23:59:59
            nullable: true
        - in: query
          name: with_deleted
          description: Whether to include deleted tracking links. Default `true`.
          example: 1
          required: false
          schema:
            type: integer
            description: Whether to include deleted tracking links. Default `true`.
            example: 1
            enum:
              - 0
              - 1
        - in: query
          name: sortby
          description: Sort by subscriber count (`claims`) or creation date
            (`created_date`).
          example: claims
          required: false
          schema:
            type: string
            description: Sort by subscriber count (`claims`) or creation date
              (`created_date`).
            example: claims
            enum:
              - claims
              - created_date
        - in: query
          name: sort
          description: Sort direction. Default `desc`.
          example: desc
          required: false
          schema:
            type: string
            description: Sort direction. Default `desc`.
            example: desc
            enum:
              - asc
              - desc
        - in: query
          name: limit
          description: The number of tracking links to return. Default `10`. Must be at
            least 1. Must not be greater than 100.
          example: 10
          required: false
          schema:
            type: integer
            description: The number of tracking links to return. Default `10`. Must be at
              least 1. Must not be greater than 100.
            example: 10
        - in: query
          name: offset
          description: The offset used for pagination. Default `0`. Must be at least 0.
          example: 0
          required: false
          schema:
            type: integer
            description: The offset used for pagination. Default `0`. Must be at least 0.
            example: 0
        - in: query
          name: pagination
          description: ""
          example: 0
          required: false
          schema:
            type: integer
            description: ""
            example: 0
            enum:
              - 0
              - 1
        - in: query
          name: synchronous
          description: Wait for revenue calculation instead of processing it in the
            background.
          example: false
          required: false
          schema:
            type: boolean
            description: Wait for revenue calculation instead of processing it in the
              background.
            example: false
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      - id: 123456
                        campaignCode: 123
                        campaignName: Example Campaign - IG Bio SFS
                        campaignUrl: https://onlyfans.com/USERNAME/c123
                        subscribersCount: 10
                        clicksCount: 100
                        createdAt: 2025-01-01T00:00:00+00:00
                        endDate: null
                        tags:
                          - Instagram
                          - Twitter
                        revenue:
                          total: 20
                          revenuePerSubscriber: 2
                          revenuePerClick: 0.2
                          spendersCount: 1
                          calculatedAt: 2025-01-01T00:00:00+00:00
                          isLoading: false
                        links:
                          related:
                            subscribers: https://app.onlyfansapi.com/api/acct_XXXXXXX/tracking-links/123456/subscribers
                    hasMore: true
                  _pagination:
                    next_page: https://app.onlyfansapi.com/api/acct_XXXXXXXXXXX/tracking-links?offset=10&limit=10
                  _meta:
                    _credits:
                      used: 1
                      balance: 9529
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49999
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          - id: 123456
                            campaignCode: 123
                            campaignName: Example Campaign - IG Bio SFS
                            campaignUrl: https://onlyfans.com/USERNAME/c123
                            subscribersCount: 10
                            clicksCount: 100
                            createdAt: 2025-01-01T00:00:00+00:00
                            endDate: null
                            tags:
                              - Instagram
                              - Twitter
                            revenue:
                              total: 20
                              revenuePerSubscriber: 2
                              revenuePerClick: 0.2
                              spendersCount: 1
                              calculatedAt: 2025-01-01T00:00:00+00:00
                              isLoading: false
                            links:
                              related:
                                subscribers: https://app.onlyfansapi.com/api/acct_XXXXXXX/tracking-links/123456/subscribers
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123456
                            campaignCode:
                              type: integer
                              example: 123
                            campaignName:
                              type: string
                              example: Example Campaign - IG Bio SFS
                            campaignUrl:
                              type: string
                              example: https://onlyfans.com/USERNAME/c123
                            subscribersCount:
                              type: integer
                              example: 10
                            clicksCount:
                              type: integer
                              example: 100
                            createdAt:
                              type: string
                              example: 2025-01-01T00:00:00+00:00
                            endDate:
                              type: string
                              example: null
                              nullable: true
                            tags:
                              type: array
                              example:
                                - Instagram
                                - Twitter
                              items:
                                type: string
                            revenue:
                              type: object
                              properties:
                                total:
                                  type: integer
                                  example: 20
                                revenuePerSubscriber:
                                  type: integer
                                  example: 2
                                revenuePerClick:
                                  type: number
                                  example: 0.2
                                spendersCount:
                                  type: integer
                                  example: 1
                                calculatedAt:
                                  type: string
                                  example: 2025-01-01T00:00:00+00:00
                                isLoading:
                                  type: boolean
                                  example: false
                            links:
                              type: object
                              properties:
                                related:
                                  type: object
                                  properties:
                                    subscribers:
                                      type: string
                                      example: https://app.onlyfansapi.com/api/acct_XXXXXXX/tracking-links/123456/subscribers
                      hasMore:
                        type: boolean
                        example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: https://app.onlyfansapi.com/api/acct_XXXXXXXXXXX/tracking-links?offset=10&limit=10
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 9529
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49999
      tags:
        - Tracking Links
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Remove Tracking Link Tags (/api-reference/tracking-links/remove-tracking-link-tags)

Remove tags from a specific tracking link. This is a free endpoint.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml delete /api/{account}/tracking-links/{tracking_link_id}/tags
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/tracking-links/{tracking_link_id}/tags:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: tracking_link_id
        description: The ID of the tracking link
        example: 123456789
        required: true
        schema:
          type: integer
    delete:
      summary: Remove Tracking Link Tags
      operationId: removeTrackingLinkTags
      description: Remove tags from a specific tracking link. This is a free endpoint.
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    tags:
                      - Twitter
                  _meta:
                    _credits:
                      used: 0
                      balance: 9529
                      note: Free endpoint
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                properties:
                  data:
                    type: object
                    properties:
                      tags:
                        type: array
                        example:
                          - Twitter
                        items:
                          type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9529
                          note:
                            type: string
                            example: Free endpoint
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                            nullable: true
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                            nullable: true
      tags:
        - Tracking Links
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tags:
                  type: array
                  description: Array of tag names to remove from the tracking link.
                  example: '["Instagram"]'
                  items:
                    type: string
              required:
                - tags
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Block User (/api-reference/users/block-user)

Block user from accessing your profile.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/users/{user_id}/block
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/users/{user_id}/block:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: user_id
        description: The OnlyFans ID of the user to block.
        example: 123
        required: true
        schema:
          type: string
    post:
      summary: Block User
      operationId: blockUser
      description: Block user from accessing your profile.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    view: f
                    avatar: https://public.onlyfans.com/files/i/i2/i25/.../123/avatar.jpg
                    avatarThumbs:
                      c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../123/avatar.jpg
                      c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../123/avatar.jpg
                    header: https://public.onlyfans.com/files/c/cs/cse/.../123/header_image.jpg
                    headerSize:
                      width: 4386
                      height: 1224
                    headerThumbs:
                      w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../123/header_image.jpg
                      w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../123/header_image.jpg
                    id: 123
                    name: name
                    username: username
                    canLookStory: true
                    canCommentStory: true
                    hasNotViewedStory: true
                    isVerified: true
                    canPayInternal: true
                    hasScheduledStream: false
                    hasStream: false
                    hasStories: true
                    tipsEnabled: true
                    tipsTextEnabled: true
                    tipsMin: 5
                    tipsMinInternal: 1
                    tipsMax: 200
                    canEarn: true
                    canAddSubscriber: true
                    subscribePrice: 12.99
                    subscriptionBundles:
                      - id: 123
                        discount: 50
                        duration: 3
                        price: 19.49
                        canBuy: true
                    displayName: ""
                    notice: ""
                    isPaywallRequired: true
                    isRestricted: false
                    canRestrict: true
                    subscribedBy: true
                    subscribedByExpire: false
                    subscribedByExpireDate: 2025-01-01T01:01:01+00:00
                    subscribedByAutoprolong: false
                    subscribedIsExpiredNow: false
                    currentSubscribePrice: 0
                    subscribedOn: null
                    subscribedOnExpiredNow: true
                    subscribedOnDuration: 7 days
                    listsStates:
                      - id: following
                        type: following
                        name: Following
                        hasUser: true
                        canAddUser: false
                        cannotAddUserReason: ALREADY_EXISTS
                      - id: fans
                        type: fans
                        name: Fans
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: null
                      - id: recent
                        type: recent
                        name: Recent (last 24 hours)
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: SYSTEM_LIST
                      - id: tagged
                        type: tagged
                        name: Tagged
                        hasUser: true
                        canAddUser: false
                        cannotAddUserReason: ALREADY_EXISTS
                      - id: friends
                        type: friends
                        name: Friends
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                      - id: muted
                        type: muted
                        name: Muted
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                    joinDate: 2025-01-01T01:01:01+00:00
                    isReferrerAllowed: true
                    about: About
                    isMarkdownDisabledForAbout: true
                    website: null
                    wishlist: null
                    location: location
                    postsCount: 123
                    archivedPostsCount: 1
                    privateArchivedPostsCount: 123
                    photosCount: 123
                    videosCount: 63
                    audiosCount: 0
                    mediasCount: 123
                    lastSeen: 2025-01-01T01:01:01+00:00
                    favoritesCount: 123
                    favoritedCount: 123
                    showPostsInFeed: true
                    canReceiveChatMessage: true
                    isPerformer: true
                    isRealPerformer: true
                    isSpotifyConnected: false
                    subscribersCount: null
                    hasPinnedPosts: true
                    hasLabels: true
                    canChat: true
                    avatarHeaderConverterUpload: true
                    isPrivateRestriction: false
                    showSubscribersCount: false
                    showMediaCount: true
                    subscribedByData:
                      price: 0
                      newPrice: 0
                      regularPrice: 12.99
                      subscribePrice: 12.99
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: 2025-01-01T01:01:01+00:00
                      expiredAt: 2025-01-01T01:01:01+00:00
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: Set to Expire
                      isMuted: false
                      unsubscribeReason: No reason given
                      duration: 2 months
                      showPostsInFeed: true
                      subscribes:
                        - id: 123
                          userId: 123
                          subscriberId: 123
                          date: 2025-01-01T01:01:01+00:00
                          duration: 360
                          startDate: 2025-01-01T01:01:01+00:00
                          expireDate: 2025-01-01T01:01:01+00:00
                          cancelDate: null
                          price: 0
                          regularPrice: 12.99
                          discount: 0
                          earningId: 0
                          action: subscribe
                          type: trial
                          offerStart: 2025-01-01T01:01:01+00:00
                          offerEnd: null
                          isCurrent: true
                      hasActivePaidSubscriptions: false
                    subscribedOnData:
                      price: 0
                      newPrice: 0
                      regularPrice: 0
                      subscribePrice: 0
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: 2025-01-01T01:01:01+00:00
                      expiredAt: 2025-01-01T01:01:01+00:00
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: null
                      isMuted: false
                      unsubscribeReason: No reason given
                      duration: 7 days
                      tipsSumm: 0
                      subscribesSumm: 0
                      messagesSumm: 0
                      postsSumm: 0
                      streamsSumm: 0
                      totalSumm: 0
                      subscribes: []
                      hasActivePaidSubscriptions: false
                    canCreatePromotion: true
                    canCreateTrial: true
                    isAdultContent: false
                    canTrialSend: false
                    hasLinks: false
                    hasFriends: false
                    finishedStreamsCount: 0
                    shouldShowFinishedStreams: false
                    hasSavedStreams: false
                    firstPublishedPostDate: 2025-01-01T01:01:01+00:00
                    isSpringConnected: false
                    isFriend: false
                    isBlocked: false
                    canReport: true
                    canUnsubscribe: true
                    isPendingAutoprolong: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999834
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49992
                properties:
                  data:
                    type: object
                    properties:
                      view:
                        type: string
                        example: f
                      avatar:
                        type: string
                        example: https://public.onlyfans.com/files/i/i2/i25/.../123/avatar.jpg
                      avatarThumbs:
                        type: object
                        properties:
                          c50:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../123/avatar.jpg
                          c144:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../123/avatar.jpg
                      header:
                        type: string
                        example: https://public.onlyfans.com/files/c/cs/cse/.../123/header_image.jpg
                      headerSize:
                        type: object
                        properties:
                          width:
                            type: integer
                            example: 4386
                          height:
                            type: integer
                            example: 1224
                      headerThumbs:
                        type: object
                        properties:
                          w480:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../123/header_image.jpg
                          w760:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../123/header_image.jpg
                      id:
                        type: integer
                        example: 123
                      name:
                        type: string
                        example: name
                      username:
                        type: string
                        example: username
                      canLookStory:
                        type: boolean
                        example: true
                      canCommentStory:
                        type: boolean
                        example: true
                      hasNotViewedStory:
                        type: boolean
                        example: true
                      isVerified:
                        type: boolean
                        example: true
                      canPayInternal:
                        type: boolean
                        example: true
                      hasScheduledStream:
                        type: boolean
                        example: false
                      hasStream:
                        type: boolean
                        example: false
                      hasStories:
                        type: boolean
                        example: true
                      tipsEnabled:
                        type: boolean
                        example: true
                      tipsTextEnabled:
                        type: boolean
                        example: true
                      tipsMin:
                        type: integer
                        example: 5
                      tipsMinInternal:
                        type: integer
                        example: 1
                      tipsMax:
                        type: integer
                        example: 200
                      canEarn:
                        type: boolean
                        example: true
                      canAddSubscriber:
                        type: boolean
                        example: true
                      subscribePrice:
                        type: number
                        example: 12.99
                      subscriptionBundles:
                        type: array
                        example:
                          - id: 123
                            discount: 50
                            duration: 3
                            price: 19.49
                            canBuy: true
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            discount:
                              type: integer
                              example: 50
                            duration:
                              type: integer
                              example: 3
                            price:
                              type: number
                              example: 19.49
                            canBuy:
                              type: boolean
                              example: true
                      displayName:
                        type: string
                        example: ""
                      notice:
                        type: string
                        example: ""
                      isPaywallRequired:
                        type: boolean
                        example: true
                      isRestricted:
                        type: boolean
                        example: false
                      canRestrict:
                        type: boolean
                        example: true
                      subscribedBy:
                        type: boolean
                        example: true
                      subscribedByExpire:
                        type: boolean
                        example: false
                      subscribedByExpireDate:
                        type: string
                        example: 2025-01-01T01:01:01+00:00
                      subscribedByAutoprolong:
                        type: boolean
                        example: false
                      subscribedIsExpiredNow:
                        type: boolean
                        example: false
                      currentSubscribePrice:
                        type: integer
                        example: 0
                      subscribedOn:
                        type: string
                        example: null
                        nullable: true
                      subscribedOnExpiredNow:
                        type: boolean
                        example: true
                      subscribedOnDuration:
                        type: string
                        example: 7 days
                      listsStates:
                        type: array
                        example:
                          - id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: fans
                            type: fans
                            name: Fans
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          - id: recent
                            type: recent
                            name: Recent (last 24 hours)
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          - id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: following
                            type:
                              type: string
                              example: following
                            name:
                              type: string
                              example: Following
                            hasUser:
                              type: boolean
                              example: true
                            canAddUser:
                              type: boolean
                              example: false
                            cannotAddUserReason:
                              type: string
                              example: ALREADY_EXISTS
                      joinDate:
                        type: string
                        example: 2025-01-01T01:01:01+00:00
                      isReferrerAllowed:
                        type: boolean
                        example: true
                      about:
                        type: string
                        example: About
                      isMarkdownDisabledForAbout:
                        type: boolean
                        example: true
                      website:
                        type: string
                        example: null
                        nullable: true
                      wishlist:
                        type: string
                        example: null
                        nullable: true
                      location:
                        type: string
                        example: location
                      postsCount:
                        type: integer
                        example: 123
                      archivedPostsCount:
                        type: integer
                        example: 1
                      privateArchivedPostsCount:
                        type: integer
                        example: 123
                      photosCount:
                        type: integer
                        example: 123
                      videosCount:
                        type: integer
                        example: 63
                      audiosCount:
                        type: integer
                        example: 0
                      mediasCount:
                        type: integer
                        example: 123
                      lastSeen:
                        type: string
                        example: 2025-01-01T01:01:01+00:00
                      favoritesCount:
                        type: integer
                        example: 123
                      favoritedCount:
                        type: integer
                        example: 123
                      showPostsInFeed:
                        type: boolean
                        example: true
                      canReceiveChatMessage:
                        type: boolean
                        example: true
                      isPerformer:
                        type: boolean
                        example: true
                      isRealPerformer:
                        type: boolean
                        example: true
                      isSpotifyConnected:
                        type: boolean
                        example: false
                      subscribersCount:
                        type: string
                        example: null
                        nullable: true
                      hasPinnedPosts:
                        type: boolean
                        example: true
                      hasLabels:
                        type: boolean
                        example: true
                      canChat:
                        type: boolean
                        example: true
                      avatarHeaderConverterUpload:
                        type: boolean
                        example: true
                      isPrivateRestriction:
                        type: boolean
                        example: false
                      showSubscribersCount:
                        type: boolean
                        example: false
                      showMediaCount:
                        type: boolean
                        example: true
                      subscribedByData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: number
                            example: 12.99
                          subscribePrice:
                            type: number
                            example: 12.99
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: 2025-01-01T01:01:01+00:00
                          expiredAt:
                            type: string
                            example: 2025-01-01T01:01:01+00:00
                          renewedAt:
                            type: string
                            example: null
                            nullable: true
                          discountFinishedAt:
                            type: string
                            example: null
                            nullable: true
                          discountStartedAt:
                            type: string
                            example: null
                            nullable: true
                          status:
                            type: string
                            example: Set to Expire
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: No reason given
                          duration:
                            type: string
                            example: 2 months
                          showPostsInFeed:
                            type: boolean
                            example: true
                          subscribes:
                            type: array
                            example:
                              - id: 123
                                userId: 123
                                subscriberId: 123
                                date: 2025-01-01T01:01:01+00:00
                                duration: 360
                                startDate: 2025-01-01T01:01:01+00:00
                                expireDate: 2025-01-01T01:01:01+00:00
                                cancelDate: null
                                price: 0
                                regularPrice: 12.99
                                discount: 0
                                earningId: 0
                                action: subscribe
                                type: trial
                                offerStart: 2025-01-01T01:01:01+00:00
                                offerEnd: null
                                isCurrent: true
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                userId:
                                  type: integer
                                  example: 123
                                subscriberId:
                                  type: integer
                                  example: 123
                                date:
                                  type: string
                                  example: 2025-01-01T01:01:01+00:00
                                duration:
                                  type: integer
                                  example: 360
                                startDate:
                                  type: string
                                  example: 2025-01-01T01:01:01+00:00
                                expireDate:
                                  type: string
                                  example: 2025-01-01T01:01:01+00:00
                                cancelDate:
                                  type: string
                                  example: null
                                  nullable: true
                                price:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: number
                                  example: 12.99
                                discount:
                                  type: integer
                                  example: 0
                                earningId:
                                  type: integer
                                  example: 0
                                action:
                                  type: string
                                  example: subscribe
                                type:
                                  type: string
                                  example: trial
                                offerStart:
                                  type: string
                                  example: 2025-01-01T01:01:01+00:00
                                offerEnd:
                                  type: string
                                  example: null
                                  nullable: true
                                isCurrent:
                                  type: boolean
                                  example: true
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      subscribedOnData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: integer
                            example: 0
                          subscribePrice:
                            type: integer
                            example: 0
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: 2025-01-01T01:01:01+00:00
                          expiredAt:
                            type: string
                            example: 2025-01-01T01:01:01+00:00
                          renewedAt:
                            type: string
                            example: null
                            nullable: true
                          discountFinishedAt:
                            type: string
                            example: null
                            nullable: true
                          discountStartedAt:
                            type: string
                            example: null
                            nullable: true
                          status:
                            type: string
                            example: null
                            nullable: true
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: No reason given
                          duration:
                            type: string
                            example: 7 days
                          tipsSumm:
                            type: integer
                            example: 0
                          subscribesSumm:
                            type: integer
                            example: 0
                          messagesSumm:
                            type: integer
                            example: 0
                          postsSumm:
                            type: integer
                            example: 0
                          streamsSumm:
                            type: integer
                            example: 0
                          totalSumm:
                            type: integer
                            example: 0
                          subscribes:
                            type: array
                            example: []
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      canCreatePromotion:
                        type: boolean
                        example: true
                      canCreateTrial:
                        type: boolean
                        example: true
                      isAdultContent:
                        type: boolean
                        example: false
                      canTrialSend:
                        type: boolean
                        example: false
                      hasLinks:
                        type: boolean
                        example: false
                      hasFriends:
                        type: boolean
                        example: false
                      finishedStreamsCount:
                        type: integer
                        example: 0
                      shouldShowFinishedStreams:
                        type: boolean
                        example: false
                      hasSavedStreams:
                        type: boolean
                        example: false
                      firstPublishedPostDate:
                        type: string
                        example: 2025-01-01T01:01:01+00:00
                      isSpringConnected:
                        type: boolean
                        example: false
                      isFriend:
                        type: boolean
                        example: false
                      isBlocked:
                        type: boolean
                        example: false
                      canReport:
                        type: boolean
                        example: true
                      canUnsubscribe:
                        type: boolean
                        example: true
                      isPendingAutoprolong:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999834
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49992
      tags:
        - Users
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Get User Details (/api-reference/users/get-user-details)

Get OnlyFans Profile details for a given username. User details are retrieved using the current `{account}` so fields like `subscribedOnData` which include potential subscription details will be included.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/users/{username}
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/users/{username}:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: username
        description: The OnlyFans username of the user to retrieve details for.
        example: exampleuser
        required: true
        schema:
          type: string
    get:
      summary: Get User Details
      operationId: getUserDetails
      description: Get OnlyFans Profile details for a given username. User details are
        retrieved using the current `{account}` so fields like
        `subscribedOnData` which include potential subscription details will be
        included.
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    view: f
                    avatar: https://public.onlyfans.com/files/i/i2/i25/.../123/avatar.jpg
                    avatarThumbs:
                      c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../123/avatar.jpg
                      c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../123/avatar.jpg
                    header: https://public.onlyfans.com/files/c/cs/cse/.../123/header_image.jpg
                    headerSize:
                      width: 4386
                      height: 1224
                    headerThumbs:
                      w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../123/header_image.jpg
                      w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../123/header_image.jpg
                    id: 123
                    name: name
                    username: username
                    canLookStory: true
                    canCommentStory: true
                    hasNotViewedStory: true
                    isVerified: true
                    canPayInternal: true
                    hasScheduledStream: false
                    hasStream: false
                    hasStories: true
                    tipsEnabled: true
                    tipsTextEnabled: true
                    tipsMin: 5
                    tipsMinInternal: 1
                    tipsMax: 200
                    canEarn: true
                    canAddSubscriber: true
                    subscribePrice: 12.99
                    subscriptionBundles:
                      - id: 123
                        discount: 50
                        duration: 3
                        price: 19.49
                        canBuy: true
                    displayName: ""
                    notice: ""
                    isPaywallRequired: true
                    isRestricted: false
                    canRestrict: true
                    subscribedBy: true
                    subscribedByExpire: false
                    subscribedByExpireDate: 2025-01-01T01:01:01+00:00
                    subscribedByAutoprolong: false
                    subscribedIsExpiredNow: false
                    currentSubscribePrice: 0
                    subscribedOn: null
                    subscribedOnExpiredNow: true
                    subscribedOnDuration: 7 days
                    listsStates:
                      - id: following
                        type: following
                        name: Following
                        hasUser: true
                        canAddUser: false
                        cannotAddUserReason: ALREADY_EXISTS
                      - id: fans
                        type: fans
                        name: Fans
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: null
                      - id: recent
                        type: recent
                        name: Recent (last 24 hours)
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: SYSTEM_LIST
                      - id: tagged
                        type: tagged
                        name: Tagged
                        hasUser: true
                        canAddUser: false
                        cannotAddUserReason: ALREADY_EXISTS
                      - id: friends
                        type: friends
                        name: Friends
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                      - id: muted
                        type: muted
                        name: Muted
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                    joinDate: 2025-01-01T01:01:01+00:00
                    isReferrerAllowed: true
                    about: About
                    isMarkdownDisabledForAbout: true
                    website: null
                    wishlist: null
                    location: location
                    postsCount: 123
                    archivedPostsCount: 1
                    privateArchivedPostsCount: 123
                    photosCount: 123
                    videosCount: 63
                    audiosCount: 0
                    mediasCount: 123
                    lastSeen: 2025-01-01T01:01:01+00:00
                    favoritesCount: 123
                    favoritedCount: 123
                    showPostsInFeed: true
                    canReceiveChatMessage: true
                    isPerformer: true
                    isRealPerformer: true
                    isSpotifyConnected: false
                    subscribersCount: null
                    hasPinnedPosts: true
                    hasLabels: true
                    canChat: true
                    avatarHeaderConverterUpload: true
                    isPrivateRestriction: false
                    showSubscribersCount: false
                    showMediaCount: true
                    subscribedByData:
                      price: 0
                      newPrice: 0
                      regularPrice: 12.99
                      subscribePrice: 12.99
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: 2025-01-01T01:01:01+00:00
                      expiredAt: 2025-01-01T01:01:01+00:00
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: Set to Expire
                      isMuted: false
                      unsubscribeReason: No reason given
                      duration: 2 months
                      showPostsInFeed: true
                      subscribes:
                        - id: 123
                          userId: 123
                          subscriberId: 123
                          date: 2025-01-01T01:01:01+00:00
                          duration: 360
                          startDate: 2025-01-01T01:01:01+00:00
                          expireDate: 2025-01-01T01:01:01+00:00
                          cancelDate: null
                          price: 0
                          regularPrice: 12.99
                          discount: 0
                          earningId: 0
                          action: subscribe
                          type: trial
                          offerStart: 2025-01-01T01:01:01+00:00
                          offerEnd: null
                          isCurrent: true
                      hasActivePaidSubscriptions: false
                    subscribedOnData:
                      price: 0
                      newPrice: 0
                      regularPrice: 0
                      subscribePrice: 0
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: 2025-01-01T01:01:01+00:00
                      expiredAt: 2025-01-01T01:01:01+00:00
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: null
                      isMuted: false
                      unsubscribeReason: No reason given
                      duration: 7 days
                      tipsSumm: 0
                      subscribesSumm: 0
                      messagesSumm: 0
                      postsSumm: 0
                      streamsSumm: 0
                      totalSumm: 0
                      subscribes: []
                      hasActivePaidSubscriptions: false
                    canCreatePromotion: true
                    canCreateTrial: true
                    isAdultContent: false
                    canTrialSend: false
                    hasLinks: false
                    hasFriends: false
                    finishedStreamsCount: 0
                    shouldShowFinishedStreams: false
                    hasSavedStreams: false
                    firstPublishedPostDate: 2025-01-01T01:01:01+00:00
                    isSpringConnected: false
                    isFriend: false
                    isBlocked: false
                    canReport: true
                    canUnsubscribe: true
                    isPendingAutoprolong: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999834
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49992
                properties:
                  data:
                    type: object
                    properties:
                      view:
                        type: string
                        example: f
                      avatar:
                        type: string
                        example: https://public.onlyfans.com/files/i/i2/i25/.../123/avatar.jpg
                      avatarThumbs:
                        type: object
                        properties:
                          c50:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../123/avatar.jpg
                          c144:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../123/avatar.jpg
                      header:
                        type: string
                        example: https://public.onlyfans.com/files/c/cs/cse/.../123/header_image.jpg
                      headerSize:
                        type: object
                        properties:
                          width:
                            type: integer
                            example: 4386
                          height:
                            type: integer
                            example: 1224
                      headerThumbs:
                        type: object
                        properties:
                          w480:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../123/header_image.jpg
                          w760:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../123/header_image.jpg
                      id:
                        type: integer
                        example: 123
                      name:
                        type: string
                        example: name
                      username:
                        type: string
                        example: username
                      canLookStory:
                        type: boolean
                        example: true
                      canCommentStory:
                        type: boolean
                        example: true
                      hasNotViewedStory:
                        type: boolean
                        example: true
                      isVerified:
                        type: boolean
                        example: true
                      canPayInternal:
                        type: boolean
                        example: true
                      hasScheduledStream:
                        type: boolean
                        example: false
                      hasStream:
                        type: boolean
                        example: false
                      hasStories:
                        type: boolean
                        example: true
                      tipsEnabled:
                        type: boolean
                        example: true
                      tipsTextEnabled:
                        type: boolean
                        example: true
                      tipsMin:
                        type: integer
                        example: 5
                      tipsMinInternal:
                        type: integer
                        example: 1
                      tipsMax:
                        type: integer
                        example: 200
                      canEarn:
                        type: boolean
                        example: true
                      canAddSubscriber:
                        type: boolean
                        example: true
                      subscribePrice:
                        type: number
                        example: 12.99
                      subscriptionBundles:
                        type: array
                        example:
                          - id: 123
                            discount: 50
                            duration: 3
                            price: 19.49
                            canBuy: true
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            discount:
                              type: integer
                              example: 50
                            duration:
                              type: integer
                              example: 3
                            price:
                              type: number
                              example: 19.49
                            canBuy:
                              type: boolean
                              example: true
                      displayName:
                        type: string
                        example: ""
                      notice:
                        type: string
                        example: ""
                      isPaywallRequired:
                        type: boolean
                        example: true
                      isRestricted:
                        type: boolean
                        example: false
                      canRestrict:
                        type: boolean
                        example: true
                      subscribedBy:
                        type: boolean
                        example: true
                      subscribedByExpire:
                        type: boolean
                        example: false
                      subscribedByExpireDate:
                        type: string
                        example: 2025-01-01T01:01:01+00:00
                      subscribedByAutoprolong:
                        type: boolean
                        example: false
                      subscribedIsExpiredNow:
                        type: boolean
                        example: false
                      currentSubscribePrice:
                        type: integer
                        example: 0
                      subscribedOn:
                        type: string
                        example: null
                        nullable: true
                      subscribedOnExpiredNow:
                        type: boolean
                        example: true
                      subscribedOnDuration:
                        type: string
                        example: 7 days
                      listsStates:
                        type: array
                        example:
                          - id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: fans
                            type: fans
                            name: Fans
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          - id: recent
                            type: recent
                            name: Recent (last 24 hours)
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          - id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          - id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: following
                            type:
                              type: string
                              example: following
                            name:
                              type: string
                              example: Following
                            hasUser:
                              type: boolean
                              example: true
                            canAddUser:
                              type: boolean
                              example: false
                            cannotAddUserReason:
                              type: string
                              example: ALREADY_EXISTS
                      joinDate:
                        type: string
                        example: 2025-01-01T01:01:01+00:00
                      isReferrerAllowed:
                        type: boolean
                        example: true
                      about:
                        type: string
                        example: About
                      isMarkdownDisabledForAbout:
                        type: boolean
                        example: true
                      website:
                        type: string
                        example: null
                        nullable: true
                      wishlist:
                        type: string
                        example: null
                        nullable: true
                      location:
                        type: string
                        example: location
                      postsCount:
                        type: integer
                        example: 123
                      archivedPostsCount:
                        type: integer
                        example: 1
                      privateArchivedPostsCount:
                        type: integer
                        example: 123
                      photosCount:
                        type: integer
                        example: 123
                      videosCount:
                        type: integer
                        example: 63
                      audiosCount:
                        type: integer
                        example: 0
                      mediasCount:
                        type: integer
                        example: 123
                      lastSeen:
                        type: string
                        example: 2025-01-01T01:01:01+00:00
                      favoritesCount:
                        type: integer
                        example: 123
                      favoritedCount:
                        type: integer
                        example: 123
                      showPostsInFeed:
                        type: boolean
                        example: true
                      canReceiveChatMessage:
                        type: boolean
                        example: true
                      isPerformer:
                        type: boolean
                        example: true
                      isRealPerformer:
                        type: boolean
                        example: true
                      isSpotifyConnected:
                        type: boolean
                        example: false
                      subscribersCount:
                        type: string
                        example: null
                        nullable: true
                      hasPinnedPosts:
                        type: boolean
                        example: true
                      hasLabels:
                        type: boolean
                        example: true
                      canChat:
                        type: boolean
                        example: true
                      avatarHeaderConverterUpload:
                        type: boolean
                        example: true
                      isPrivateRestriction:
                        type: boolean
                        example: false
                      showSubscribersCount:
                        type: boolean
                        example: false
                      showMediaCount:
                        type: boolean
                        example: true
                      subscribedByData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: number
                            example: 12.99
                          subscribePrice:
                            type: number
                            example: 12.99
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: 2025-01-01T01:01:01+00:00
                          expiredAt:
                            type: string
                            example: 2025-01-01T01:01:01+00:00
                          renewedAt:
                            type: string
                            example: null
                            nullable: true
                          discountFinishedAt:
                            type: string
                            example: null
                            nullable: true
                          discountStartedAt:
                            type: string
                            example: null
                            nullable: true
                          status:
                            type: string
                            example: Set to Expire
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: No reason given
                          duration:
                            type: string
                            example: 2 months
                          showPostsInFeed:
                            type: boolean
                            example: true
                          subscribes:
                            type: array
                            example:
                              - id: 123
                                userId: 123
                                subscriberId: 123
                                date: 2025-01-01T01:01:01+00:00
                                duration: 360
                                startDate: 2025-01-01T01:01:01+00:00
                                expireDate: 2025-01-01T01:01:01+00:00
                                cancelDate: null
                                price: 0
                                regularPrice: 12.99
                                discount: 0
                                earningId: 0
                                action: subscribe
                                type: trial
                                offerStart: 2025-01-01T01:01:01+00:00
                                offerEnd: null
                                isCurrent: true
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                userId:
                                  type: integer
                                  example: 123
                                subscriberId:
                                  type: integer
                                  example: 123
                                date:
                                  type: string
                                  example: 2025-01-01T01:01:01+00:00
                                duration:
                                  type: integer
                                  example: 360
                                startDate:
                                  type: string
                                  example: 2025-01-01T01:01:01+00:00
                                expireDate:
                                  type: string
                                  example: 2025-01-01T01:01:01+00:00
                                cancelDate:
                                  type: string
                                  example: null
                                  nullable: true
                                price:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: number
                                  example: 12.99
                                discount:
                                  type: integer
                                  example: 0
                                earningId:
                                  type: integer
                                  example: 0
                                action:
                                  type: string
                                  example: subscribe
                                type:
                                  type: string
                                  example: trial
                                offerStart:
                                  type: string
                                  example: 2025-01-01T01:01:01+00:00
                                offerEnd:
                                  type: string
                                  example: null
                                  nullable: true
                                isCurrent:
                                  type: boolean
                                  example: true
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      subscribedOnData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: integer
                            example: 0
                          subscribePrice:
                            type: integer
                            example: 0
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: 2025-01-01T01:01:01+00:00
                          expiredAt:
                            type: string
                            example: 2025-01-01T01:01:01+00:00
                          renewedAt:
                            type: string
                            example: null
                            nullable: true
                          discountFinishedAt:
                            type: string
                            example: null
                            nullable: true
                          discountStartedAt:
                            type: string
                            example: null
                            nullable: true
                          status:
                            type: string
                            example: null
                            nullable: true
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: No reason given
                          duration:
                            type: string
                            example: 7 days
                          tipsSumm:
                            type: integer
                            example: 0
                          subscribesSumm:
                            type: integer
                            example: 0
                          messagesSumm:
                            type: integer
                            example: 0
                          postsSumm:
                            type: integer
                            example: 0
                          streamsSumm:
                            type: integer
                            example: 0
                          totalSumm:
                            type: integer
                            example: 0
                          subscribes:
                            type: array
                            example: []
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      canCreatePromotion:
                        type: boolean
                        example: true
                      canCreateTrial:
                        type: boolean
                        example: true
                      isAdultContent:
                        type: boolean
                        example: false
                      canTrialSend:
                        type: boolean
                        example: false
                      hasLinks:
                        type: boolean
                        example: false
                      hasFriends:
                        type: boolean
                        example: false
                      finishedStreamsCount:
                        type: integer
                        example: 0
                      shouldShowFinishedStreams:
                        type: boolean
                        example: false
                      hasSavedStreams:
                        type: boolean
                        example: false
                      firstPublishedPostDate:
                        type: string
                        example: 2025-01-01T01:01:01+00:00
                      isSpringConnected:
                        type: boolean
                        example: false
                      isFriend:
                        type: boolean
                        example: false
                      isBlocked:
                        type: boolean
                        example: false
                      canReport:
                        type: boolean
                        example: true
                      canUnsubscribe:
                        type: boolean
                        example: true
                      isPendingAutoprolong:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999834
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49992
      tags:
        - Users
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````

# Mass-List User Details (/api-reference/users/mass-list-user-details)

Save on credits by getting up to 10 user details with a single request. User details are retrieved using the current `{account}` so fields like `subscribedOnData` which include potential subscription details will be included.

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/users/list
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/users/list:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
    get:
      summary: Mass-List User Details
      operationId: massListUserDetails
      description: Save on credits by getting up to 10 user details with a single
        request. User details are retrieved using the current `{account}` so
        fields like `subscribedOnData` which include potential subscription
        details will be included.
      parameters:
        - in: query
          name: ids
          description: Comma-separated list of user IDs (max. 10 IDs). Must be at least 1
            character.
          example: 12412412,36139491,1858349
          required: true
          schema:
            type: string
            description: Comma-separated list of user IDs (max. 10 IDs). Must be at least 1
              character.
            example: 12412412,36139491,1858349
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    "1000000":
                      view: f
                      avatar: https://example.com/redacted.jpg
                      avatarThumbs:
                        c50: https://example.com/redacted.jpg
                        c144: https://example.com/redacted.jpg
                      header: null
                      headerSize: null
                      headerThumbs: null
                      id: 1000000
                      name: Example User
                      username: example_user
                      canLookStory: true
                      canCommentStory: true
                      hasNotViewedStory: false
                      isVerified: true
                      canPayInternal: true
                      hasScheduledStream: false
                      hasStream: false
                      hasStories: false
                      tipsEnabled: false
                      tipsTextEnabled: true
                      tipsMin: 5
                      tipsMinInternal: 1
                      tipsMax: 200
                      canEarn: true
                      canAddSubscriber: false
                      subscribePrice: 0
                      displayName: Example User
                      notice: ""
                      isPaywallRequired: true
                      isActive: true
                      isRestricted: false
                      canRestrict: true
                      subscribedBy: true
                      subscribedByExpire: false
                      subscribedByExpireDate: 2024-01-01T00:00:00+00:00
                      subscribedByAutoprolong: false
                      subscribedIsExpiredNow: false
                      currentSubscribePrice: 0
                      subscribedOn: null
                      subscribedOnExpiredNow: true
                      subscribedOnDuration: 1 month
                      listsStates:
                        - id: redacted_id
                          type: muted
                          name: Example User
                          hasUser: false
                          canAddUser: true
                          cannotAddUserReason: null
                        - id: redacted_id
                          type: fans
                          name: Example User
                          hasUser: false
                          canAddUser: false
                          cannotAddUserReason: null
                        - id: redacted_id
                          type: following
                          name: Example User
                          hasUser: true
                          canAddUser: false
                          cannotAddUserReason: ALREADY_EXISTS
                        - id: redacted_id
                          type: recent
                          name: Example User
                          hasUser: false
                          canAddUser: false
                          cannotAddUserReason: SYSTEM_LIST
                        - id: redacted_id
                          type: friends
                          name: Example User
                          hasUser: false
                          canAddUser: true
                          cannotAddUserReason: null
                        - id: 1000000
                          type: custom
                          name: Example User
                          hasUser: true
                          canAddUser: false
                          cannotAddUserReason: ALREADY_EXISTS
                        - id: 1000000
                          type: custom
                          name: Example User
                          hasUser: true
                          canAddUser: false
                          cannotAddUserReason: ALREADY_EXISTS
                        - id: redacted_id
                          type: rebill_off
                          name: Example User
                          hasUser: false
                          canAddUser: false
                          cannotAddUserReason: null
                        - id: redacted_id
                          type: rebill_on
                          name: Example User
                          hasUser: false
                          canAddUser: false
                          cannotAddUserReason: null
                        - id: redacted_id
                          type: tagged
                          name: Example User
                          hasUser: false
                          canAddUser: false
                          cannotAddUserReason: SYSTEM_LIST
                      joinDate: 2024-01-01T00:00:00+00:00
                      isReferrerAllowed: true
                      about: ""
                      isMarkdownDisabledForAbout: false
                      website: null
                      wishlist: null
                      location: null
                      postsCount: 0
                      archivedPostsCount: 0
                      privateArchivedPostsCount: 0
                      photosCount: 0
                      videosCount: 0
                      audiosCount: 0
                      mediasCount: 0
                      lastSeen: 2024-01-01T00:00:00+00:00
                      favoritesCount: 0
                      favoritedCount: 0
                      showPostsInFeed: true
                      canReceiveChatMessage: true
                      isPerformer: true
                      isRealPerformer: true
                      isSpotifyConnected: false
                      subscribersCount: null
                      hasPinnedPosts: false
                      hasLabels: false
                      canChat: true
                      avatarHeaderConverterUpload: true
                      isPrivateRestriction: false
                      showSubscribersCount: false
                      showMediaCount: true
                      subscribedByData:
                        price: 0
                        newPrice: 0
                        regularPrice: 0
                        subscribePrice: 0
                        discountPercent: 0
                        discountPeriod: 1
                        subscribeAt: 2024-01-01T00:00:00+00:00
                        expiredAt: 2024-01-01T00:00:00+00:00
                        renewedAt: null
                        discountFinishedAt: null
                        discountStartedAt: null
                        status: Set to Expire
                        isMuted: false
                        unsubscribeReason: Redacted
                        duration: 6 months
                        showPostsInFeed: true
                        subscribes:
                          - id: 1000000
                            userId: 1000000
                            subscriberId: 1000000
                            date: 2024-01-01T00:00:00+00:00
                            duration: 3652
                            startDate: 2024-01-01T00:00:00+00:00
                            expireDate: 2024-01-01T00:00:00+00:00
                            cancelDate: null
                            price: 0
                            regularPrice: 0
                            discount: 0
                            earningId: 0
                            action: subscribe
                            type: regular
                            offerStart: null
                            offerEnd: null
                            isCurrent: true
                          - id: 1000000
                            userId: 1000000
                            subscriberId: 1000000
                            date: 2024-01-01T00:00:00+00:00
                            duration: 3652
                            startDate: 2024-01-01T00:00:00+00:00
                            expireDate: 2024-01-01T00:00:00+00:00
                            cancelDate: null
                            price: 0
                            regularPrice: 0
                            discount: 0
                            earningId: 0
                            action: prolong
                            type: regular
                            offerStart: null
                            offerEnd: null
                            isCurrent: true
                        hasActivePaidSubscriptions: false
                      subscribedOnData:
                        price: 3.9
                        newPrice: 12.99
                        regularPrice: 12.99
                        subscribePrice: 12.99
                        discountPercent: 0
                        discountPeriod: 1
                        subscribeAt: 2024-01-01T00:00:00+00:00
                        expiredAt: 2024-01-01T00:00:00+00:00
                        renewedAt: null
                        discountFinishedAt: null
                        discountStartedAt: null
                        status: null
                        isMuted: false
                        unsubscribeReason: Redacted
                        duration: 8 months
                        tipsSumm: 0
                        subscribesSumm: 0
                        messagesSumm: 0
                        postsSumm: 0
                        streamsSumm: 0
                        totalSumm: 0
                        subscribes: []
                        hasActivePaidSubscriptions: false
                      canCreatePromotion: false
                      canCreateTrial: false
                      isAdultContent: false
                      canTrialSend: true
                      hasLinks: false
                      hasFriends: true
                      firstPublishedPostDate: 2024-01-01T00:00:00+00:00
                      isSpringConnected: false
                      isFriend: false
                      isBlocked: false
                      canReport: true
                      canUnsubscribe: true
                      isPendingAutoprolong: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 380044
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: We have decided to remove our daily rate limits. Please remove any
                        references to these in your integrations.
                properties:
                  data:
                    type: object
                    properties:
                      "1000000":
                        type: object
                        properties:
                          view:
                            type: string
                            example: f
                          avatar:
                            type: string
                            example: https://example.com/redacted.jpg
                          avatarThumbs:
                            type: object
                            properties:
                              c50:
                                type: string
                                example: https://example.com/redacted.jpg
                              c144:
                                type: string
                                example: https://example.com/redacted.jpg
                          header:
                            type: string
                            example: null
                            nullable: true
                          headerSize:
                            type: string
                            example: null
                            nullable: true
                          headerThumbs:
                            type: string
                            example: null
                            nullable: true
                          id:
                            type: integer
                            example: 1000000
                          name:
                            type: string
                            example: Example User
                          username:
                            type: string
                            example: example_user
                          canLookStory:
                            type: boolean
                            example: true
                          canCommentStory:
                            type: boolean
                            example: true
                          hasNotViewedStory:
                            type: boolean
                            example: false
                          isVerified:
                            type: boolean
                            example: true
                          canPayInternal:
                            type: boolean
                            example: true
                          hasScheduledStream:
                            type: boolean
                            example: false
                          hasStream:
                            type: boolean
                            example: false
                          hasStories:
                            type: boolean
                            example: false
                          tipsEnabled:
                            type: boolean
                            example: false
                          tipsTextEnabled:
                            type: boolean
                            example: true
                          tipsMin:
                            type: integer
                            example: 5
                          tipsMinInternal:
                            type: integer
                            example: 1
                          tipsMax:
                            type: integer
                            example: 200
                          canEarn:
                            type: boolean
                            example: true
                          canAddSubscriber:
                            type: boolean
                            example: false
                          subscribePrice:
                            type: integer
                            example: 0
                          displayName:
                            type: string
                            example: Example User
                          notice:
                            type: string
                            example: ""
                          isPaywallRequired:
                            type: boolean
                            example: true
                          isActive:
                            type: boolean
                            example: true
                          isRestricted:
                            type: boolean
                            example: false
                          canRestrict:
                            type: boolean
                            example: true
                          subscribedBy:
                            type: boolean
                            example: true
                          subscribedByExpire:
                            type: boolean
                            example: false
                          subscribedByExpireDate:
                            type: string
                            example: 2024-01-01T00:00:00+00:00
                          subscribedByAutoprolong:
                            type: boolean
                            example: false
                          subscribedIsExpiredNow:
                            type: boolean
                            example: false
                          currentSubscribePrice:
                            type: integer
                            example: 0
                          subscribedOn:
                            type: string
                            example: null
                            nullable: true
                          subscribedOnExpiredNow:
                            type: boolean
                            example: true
                          subscribedOnDuration:
                            type: string
                            example: 1 month
                          listsStates:
                            type: array
                            example:
                              - id: redacted_id
                                type: muted
                                name: Example User
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                              - id: redacted_id
                                type: fans
                                name: Example User
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: null
                              - id: redacted_id
                                type: following
                                name: Example User
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              - id: redacted_id
                                type: recent
                                name: Example User
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              - id: redacted_id
                                type: friends
                                name: Example User
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                              - id: 1000000
                                type: custom
                                name: Example User
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              - id: 1000000
                                type: custom
                                name: Example User
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              - id: redacted_id
                                type: rebill_off
                                name: Example User
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: null
                              - id: redacted_id
                                type: rebill_on
                                name: Example User
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: null
                              - id: redacted_id
                                type: tagged
                                name: Example User
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: redacted_id
                                type:
                                  type: string
                                  example: muted
                                name:
                                  type: string
                                  example: Example User
                                hasUser:
                                  type: boolean
                                  example: false
                                canAddUser:
                                  type: boolean
                                  example: true
                                cannotAddUserReason:
                                  type: string
                                  example: null
                                  nullable: true
                          joinDate:
                            type: string
                            example: 2024-01-01T00:00:00+00:00
                          isReferrerAllowed:
                            type: boolean
                            example: true
                          about:
                            type: string
                            example: ""
                          isMarkdownDisabledForAbout:
                            type: boolean
                            example: false
                          website:
                            type: string
                            example: null
                            nullable: true
                          wishlist:
                            type: string
                            example: null
                            nullable: true
                          location:
                            type: string
                            example: null
                            nullable: true
                          postsCount:
                            type: integer
                            example: 0
                          archivedPostsCount:
                            type: integer
                            example: 0
                          privateArchivedPostsCount:
                            type: integer
                            example: 0
                          photosCount:
                            type: integer
                            example: 0
                          videosCount:
                            type: integer
                            example: 0
                          audiosCount:
                            type: integer
                            example: 0
                          mediasCount:
                            type: integer
                            example: 0
                          lastSeen:
                            type: string
                            example: 2024-01-01T00:00:00+00:00
                          favoritesCount:
                            type: integer
                            example: 0
                          favoritedCount:
                            type: integer
                            example: 0
                          showPostsInFeed:
                            type: boolean
                            example: true
                          canReceiveChatMessage:
                            type: boolean
                            example: true
                          isPerformer:
                            type: boolean
                            example: true
                          isRealPerformer:
                            type: boolean
                            example: true
                          isSpotifyConnected:
                            type: boolean
                            example: false
                          subscribersCount:
                            type: string
                            example: null
                            nullable: true
                          hasPinnedPosts:
                            type: boolean
                            example: false
                          hasLabels:
                            type: boolean
                            example: false
                          canChat:
                            type: boolean
                            example: true
                          avatarHeaderConverterUpload:
                            type: boolean
                            example: true
                          isPrivateRestriction:
                            type: boolean
                            example: false
                          showSubscribersCount:
                            type: boolean
                            example: false
                          showMediaCount:
                            type: boolean
                            example: true
                          subscribedByData:
                            type: object
                            properties:
                              price:
                                type: integer
                                example: 0
                              newPrice:
                                type: integer
                                example: 0
                              regularPrice:
                                type: integer
                                example: 0
                              subscribePrice:
                                type: integer
                                example: 0
                              discountPercent:
                                type: integer
                                example: 0
                              discountPeriod:
                                type: integer
                                example: 1
                              subscribeAt:
                                type: string
                                example: 2024-01-01T00:00:00+00:00
                              expiredAt:
                                type: string
                                example: 2024-01-01T00:00:00+00:00
                              renewedAt:
                                type: string
                                example: null
                                nullable: true
                              discountFinishedAt:
                                type: string
                                example: null
                                nullable: true
                              discountStartedAt:
                                type: string
                                example: null
                                nullable: true
                              status:
                                type: string