ONonlyfansapi
Tracking Links

List Tracking Links

Changed on

List all tracking links for the account and revenue data

get/api/{account}/tracking-links

Request

  • Base URL
    https://app.onlyfansapi.com
  • URL
    https://app.onlyfansapi.com/api/{account}/tracking-links
  • Auth
    HTTP bearer

Query parameters

startDatestring nullable

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
endDatestring nullable

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
with_deleted0 | 1

Whether to include deleted tracking links. Default true.

Example:1
sortby'claims' | 'created_date'

Sort by subscriber count (claims) or creation date (created_date).

Example:claims
sort'asc' | 'desc'

Sort direction. Default desc.

Example:desc
limitinteger

The number of tracking links to return. Default 10. Must be at least 1. Must not be greater than 100.

Example:10
offsetinteger

The offset used for pagination. Default 0. Must be at least 0.

pagination0 | 1
Example:1
synchronousboolean

Wait for revenue calculation instead of processing it in the background.

Response

Success

Example response

{
  "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,
          "chargebacks": 4,
          "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
    }
  }
}

Changes

  • b3968f1bc1f0Revision changes
    • breaking

      the query request parameter with_deleted was restricted to a list of enum values

    • breaking

      for the query request parameter with_deleted, the type changed from boolean to integer

    • info

      added the new optional query request parameter pagination

    • info

      added the new enum value 0.00 to the query request parameter with_deleted

    • info

      added the new enum value 1.00 to the query request parameter with_deleted

    • info

      added the optional property //// to the response with the status

  • 93a6dfdeeb67Revision changes
    • breaking

      the response property /// became nullable for the status

    • breaking

      the //// response's property type changed from integer to number for status

    • info

      added the optional property /// to the response with the status