Analytics - Financial

Get Profitability History

Changed on

Get historical profitability data for a specific account over multiple months.

get/api/analytics/financial/profitability/{account}/history

Request

  • Base URL
    https://app.onlyfansapi.com
  • URL
    https://app.onlyfansapi.com/api/analytics/financial/profitability/{account}/history
  • Auth
    HTTP bearer

Query parameters

account_prefixed_idstring required

The account prefixed ID.

Example:acct_abc123
monthsinteger

Number of months of history to retrieve (1-60, default 12). Must be at least 1. Must not be greater than 60.

Example:12

Response

Example response

{
  "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": []
    }
  ]
}

Changes

    • breaking

      the response's body type changed from array to object for status

    • info

      added the optional property to the response with the status

    • breaking

      added the new required query request parameter account_prefixed_id

    • breaking

      removed the request body