# Introduction (/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.

## 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 |
