ONonlyfansapi
Free Trial Links

List Free Trial Links

Changed on

List all free trial links for the account, including the details and statistics

get/api/{account}/trial-links

Request

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

Query parameters

startDatestring nullable

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

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
limitinteger

The number of trial 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.

sort'asc' | 'desc'

Sort direction. Default desc.

Example:desc
field'create_date' | 'expire_date' | 'subscribe_counts' | 'subscribe_days' | 'claims_count'

Field to sort by. Default create_date.

Example:create_date
synchronousboolean

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

Response

Success

Example response

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

Changes

  • b3968f1bc1f0Revision changes
    • info

      added the new optional query request parameter endDate

    • info

      added the new optional query request parameter startDate

    • info

      the query request parameter limit became optional

    • info

      the query request parameter offset became optional

    • info

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

  • 93a6dfdeeb67Revision changes
    • breaking

      the response property /// became nullable for the status

    • info

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