# Overview (/api-reference)



import {
  BanknoteArrowDownIcon,
  BotMessageSquareIcon,
  ChartSplineIcon,
  GalleryVerticalEndIcon,
  ImageDownIcon,
  ImageIcon,
  ImageUpIcon,
  MessageSquareReplyIcon,
  MessageSquareTextIcon,
  MessagesSquareIcon,
  RocketIcon,
  ScrollTextIcon,
  SendIcon,
  SmilePlusIcon,
  UserCheckIcon,
  UserSearchIcon,
  UsersIcon,
  UserXIcon,
} from "lucide-react";

<h2 className="-mt-8 text-fd-primary">Not sure where to start?</h2>
Browse our frequently used API endpoints below to get a feel for what's possible
with OnlyFans API.

## 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/payouts/list-transactions-earnings" 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>