Authorizations
You can retrieve your token by visiting the OnlyFansAPI Console and clicking API Keys -> Create API Key.
Path Parameters
The Account ID
Query Parameters
The query to search for. Can be either a name or username.
Example:
"User"
Response
200 - application/json
Success
Example:
[
{
"view": "x",
"avatar": null,
"avatarThumbs": null,
"header": null,
"headerSize": null,
"headerThumbs": null,
"id": 123,
"name": "Name",
"username": "username",
"canLookStory": true,
"canCommentStory": true,
"hasNotViewedStory": false,
"isVerified": false,
"canPayInternal": true,
"hasScheduledStream": false,
"hasStream": false,
"hasStories": false,
"tipsEnabled": false,
"tipsTextEnabled": true,
"tipsMin": 5,
"tipsMinInternal": 1,
"tipsMax": 200,
"canEarn": false,
"canAddSubscriber": false,
"subscribePrice": 0,
"displayName": "",
"notice": "",
"isRestricted": false,
"canRestrict": true,
"subscribedBy": true,
"subscribedByExpire": false,
"subscribedByExpireDate": "2025-01-01T00:00:00+00:00",
"subscribedByAutoprolong": true,
"subscribedIsExpiredNow": false,
"currentSubscribePrice": 0,
"subscribedOn": true,
"subscribedOnExpiredNow": false,
"subscribedOnDuration": "23 days",
"listsStates": [
{
"id": "fans",
"type": "fans",
"name": "Fans",
"hasUser": true,
"canAddUser": false,
"cannotAddUserReason": "ALREADY_EXISTS"
},
{
"id": "following",
"type": "following",
"name": "Following",
"hasUser": true,
"canAddUser": false,
"cannotAddUserReason": "ALREADY_EXISTS"
},
{
"id": "friends",
"type": "friends",
"name": "Friends",
"hasUser": false,
"canAddUser": false,
"cannotAddUserReason": "USER_NOT_PERFORMER"
},
{
"id": 1181087239,
"type": "custom",
"name": "Low Spenders-1PM",
"hasUser": true,
"canAddUser": false,
"cannotAddUserReason": "ALREADY_EXISTS"
},
{
"id": "muted",
"type": "muted",
"name": "Muted",
"hasUser": false,
"canAddUser": true,
"cannotAddUserReason": null
},
{
"id": "recent",
"type": "recent",
"name": "Recent (last 24 hours)",
"hasUser": false,
"canAddUser": false,
"cannotAddUserReason": "SYSTEM_LIST"
},
{
"id": "rebill_off",
"type": "rebill_off",
"name": "Renew Off",
"hasUser": false,
"canAddUser": false,
"cannotAddUserReason": null
},
{
"id": "rebill_on",
"type": "rebill_on",
"name": "Renew On",
"hasUser": true,
"canAddUser": false,
"cannotAddUserReason": "ALREADY_EXISTS"
},
{
"id": "tagged",
"type": "tagged",
"name": "Tagged",
"hasUser": false,
"canAddUser": false,
"cannotAddUserReason": "SYSTEM_LIST"
}
],
"canReport": true,
"canReceiveChatMessage": true,
"hideChat": false,
"lastSeen": "2025-01-01T00:00:00+00:00",
"isPerformer": false,
"isRealPerformer": false,
"subscribedByData": {
"price": 0,
"newPrice": 0,
"regularPrice": 0,
"subscribePrice": 0,
"discountPercent": 0,
"discountPeriod": 1,
"subscribeAt": "2025-01-01T00:00:00+00:00",
"expiredAt": "2025-01-01T00:00:00+00:00",
"renewedAt": "2025-01-01T00:00:00+00:00",
"discountFinishedAt": null,
"discountStartedAt": null,
"status": null,
"isMuted": false,
"unsubscribeReason": "No reason given",
"duration": "23 days",
"showPostsInFeed": true,
"subscribes": [
{
"id": 123,
"userId": 123,
"subscriberId": 123,
"date": "2025-01-01T00:00:00+00:00",
"duration": 123,
"startDate": "2025-01-01T00:00:00+00:00",
"expireDate": "2025-01-01T00:00:00+00:00",
"cancelDate": null,
"price": 0,
"regularPrice": 0,
"discount": 0,
"earningId": 0,
"action": "subscribe",
"type": "auto",
"offerStart": null,
"offerEnd": null,
"isCurrent": true
}
],
"hasActivePaidSubscriptions": false
},
"subscribedOnData": {
"price": 5,
"newPrice": 20,
"regularPrice": 5,
"subscribePrice": 5,
"discountPercent": 0,
"discountPeriod": 1,
"subscribeAt": "2025-01-01T00:00:00+00:00",
"expiredAt": "2025-01-01T00:00:00+00:00",
"renewedAt": "2025-01-01T00:00:00+00:00",
"discountFinishedAt": null,
"discountStartedAt": null,
"status": null,
"isMuted": false,
"unsubscribeReason": "No reason given",
"duration": "23 days",
"tipsSumm": 0,
"subscribesSumm": 4,
"messagesSumm": 0,
"postsSumm": 0,
"streamsSumm": 0,
"totalSumm": 4,
"lastActivity": "2025-01-01T00:00:00+00:00",
"recommendations": 0,
"subscribes": [
{
"id": 123,
"userId": 213,
"subscriberId": 123,
"date": "2025-01-01T00:00:00+00:00",
"duration": 30,
"startDate": "2025-01-01T00:00:00+00:00",
"expireDate": "2025-01-01T00:00:00+00:00",
"cancelDate": null,
"price": 5,
"regularPrice": 20,
"discount": 75,
"earningId": 123,
"action": "subscribe",
"type": "promo",
"offerStart": "2025-01-01T00:00:00+00:00",
"offerEnd": "2025-01-01T00:00:00+00:00",
"isCurrent": true
}
],
"hasActivePaidSubscriptions": true
},
"canTrialSend": false,
"isBlocked": false,
"promoOffers": [],
"canUnsubscribe": true,
"isPendingAutoprolong": false
}
]