api.md

Whoami

Types:

from onlyfansapi.types import WhoamiRetrieveResponse

Methods:

• client.whoami.retrieve() -> WhoamiRetrieveResponse

Accounts

Types:

from onlyfansapi.types import AccountListResponse, AccountDisconnectResponse

Methods:

• client.accounts.list(**params) -> AccountListResponse
• client.accounts.disconnect(id) -> Optional[AccountDisconnectResponse]

Me

Types:

from onlyfansapi.types import (
    MeRetrieveResponse,
    MeGetModelStartDateResponse,
    MeGetTopPercentageResponse,
)

Methods:

• client.me.retrieve(account) -> MeRetrieveResponse
• client.me.get_model_start_date(account) -> MeGetModelStartDateResponse
• client.me.get_top_percentage(account) -> MeGetTopPercentageResponse

Analytics

Financial

Types:

from onlyfansapi.types.analytics import FinancialGetForecastResponse

Methods:

• client.analytics.financial.get_forecast(**params) -> FinancialGetForecastResponse

Transactions

Types:

from onlyfansapi.types.analytics.financial import (
    TransactionGetByTypeResponse,
    TransactionGetSummaryResponse,
)

Methods:

• client.analytics.financial.transactions.get_by_type(**params) -> TransactionGetByTypeResponse
• client.analytics.financial.transactions.get_summary(**params) -> TransactionGetSummaryResponse

Profitability

Types:

from onlyfansapi.types.analytics.financial import (
    ProfitabilityGetHistoryResponse,
    ProfitabilityGetProfitabilityResponse,
)

Methods:

• client.analytics.financial.profitability.get_history(account, **params) -> ProfitabilityGetHistoryResponse
• client.analytics.financial.profitability.get_profitability(**params) -> ProfitabilityGetProfitabilityResponse

Summary

Types:

from onlyfansapi.types.analytics import (
    SummaryGetEarningsOverviewResponse,
    SummaryGetHistoricalPerformanceResponse,
    SummaryGetPeriodComparisonResponse,
)

Methods:

• client.analytics.summary.get_earnings_overview(**params) -> SummaryGetEarningsOverviewResponse
• client.analytics.summary.get_historical_performance(**params) -> SummaryGetHistoricalPerformanceResponse
• client.analytics.summary.get_period_comparison(**params) -> SummaryGetPeriodComparisonResponse

Banking

Types:

from onlyfansapi.types import (
    BankingListAvailablePayoutSystemsResponse,
    BankingListCountriesResponse,
)

Methods:

• client.banking.list_available_payout_systems(account) -> BankingListAvailablePayoutSystemsResponse
• client.banking.list_countries(account) -> BankingListCountriesResponse

Details

Types:

from onlyfansapi.types.banking import (
    DetailRetrieveAccountCountryDetailsResponse,
    DetailRetrieveBankDetailsResponse,
    DetailRetrieveDac7FormDetailsResponse,
    DetailRetrieveLegalAndTaxStatusResponse,
    DetailRetrieveLegalFormDetailsResponse,
)

Methods:

• client.banking.details.retrieve_account_country_details(account) -> DetailRetrieveAccountCountryDetailsResponse
• client.banking.details.retrieve_bank_details(account) -> DetailRetrieveBankDetailsResponse
• client.banking.details.retrieve_dac7_form_details(account) -> DetailRetrieveDac7FormDetailsResponse
• client.banking.details.retrieve_legal_and_tax_status(account) -> DetailRetrieveLegalAndTaxStatusResponse
• client.banking.details.retrieve_legal_form_details(account) -> DetailRetrieveLegalFormDetailsResponse

Chargebacks

Types:

from onlyfansapi.types import (
    ChargebackListResponse,
    ChargebackCalculateRatioResponse,
    ChargebackListStatisticsResponse,
)

Methods:

• client.chargebacks.list(account, **params) -> ChargebackListResponse
• client.chargebacks.calculate_ratio(account, **params) -> ChargebackCalculateRatioResponse
• client.chargebacks.list_statistics(account, **params) -> ChargebackListStatisticsResponse

Chats

Types:

from onlyfansapi.types import (
    ChatListResponse,
    ChatDeleteResponse,
    ChatHideResponse,
    ChatListMediaResponse,
    ChatMarkAsReadResponse,
    ChatMarkAsUnreadResponse,
    ChatMuteResponse,
    ChatStartTypingResponse,
    ChatUnmuteResponse,
)

Methods:

• client.chats.list(account, **params) -> ChatListResponse
• client.chats.delete(chat_id, *, account) -> ChatDeleteResponse
• client.chats.hide(chat_id, *, account) -> ChatHideResponse
• client.chats.list_media(chat_id, *, account, **params) -> ChatListMediaResponse
• client.chats.mark_as_read(chat_id, *, account) -> ChatMarkAsReadResponse
• client.chats.mark_as_unread(chat_id, *, account) -> ChatMarkAsUnreadResponse
• client.chats.mute(chat_id, *, account) -> ChatMuteResponse
• client.chats.start_typing(chat_id, *, account) -> ChatStartTypingResponse
• client.chats.unmute(chat_id, *, account) -> ChatUnmuteResponse

Messages

Types:

from onlyfansapi.types.chats import (
    MessageRetrieveResponse,
    MessageListResponse,
    MessageDeleteResponse,
    MessageLikeResponse,
    MessagePinResponse,
    MessageSearchResponse,
    MessageSendResponse,
    MessageUnlikeResponse,
    MessageUnpinResponse,
)

Methods:

• client.chats.messages.retrieve(message_id, *, account, chat_id) -> MessageRetrieveResponse
• client.chats.messages.list(chat_id, *, account, **params) -> MessageListResponse
• client.chats.messages.delete(message_id, *, account, chat_id) -> MessageDeleteResponse
• client.chats.messages.like(message_id, *, account, chat_id) -> MessageLikeResponse
• client.chats.messages.pin(message_id, *, account, chat_id) -> MessagePinResponse
• client.chats.messages.search(chat_id, *, account, **params) -> MessageSearchResponse
• client.chats.messages.send(chat_id, *, account, **params) -> MessageSendResponse
• client.chats.messages.unlike(message_id, *, account, chat_id) -> MessageUnlikeResponse
• client.chats.messages.unpin(message_id, *, account, chat_id) -> MessageUnpinResponse

MarkAllAsRead

Types:

from onlyfansapi.types.chats import MarkAllAsReadAllResponse

Methods:

• client.chats.mark_all_as_read.all(account) -> MarkAllAsReadAllResponse

Messages

Types:

from onlyfansapi.types import MessageAttachTagsResponse

Methods:

• client.messages.attach_tags(message_id, *, account, **params) -> MessageAttachTagsResponse

ClientSessions

Types:

from onlyfansapi.types import ClientSessionCreateResponse

Methods:

• client.client_sessions.create(**params) -> ClientSessionCreateResponse

Authenticate

Types:

from onlyfansapi.types import (
    AuthenticatePollStatusResponse,
    AuthenticateReauthenticateResponse,
    AuthenticateSend2faEmailResponse,
    AuthenticateStartResponse,
    AuthenticateSubmit2faResponse,
)

Methods:

• client.authenticate.poll_status(attempt_id) -> AuthenticatePollStatusResponse
• client.authenticate.reauthenticate(account_id) -> AuthenticateReauthenticateResponse
• client.authenticate.send_2fa_email(attempt_id) -> AuthenticateSend2faEmailResponse
• client.authenticate.start(**params) -> AuthenticateStartResponse
• client.authenticate.submit_2fa(attempt_id, **params) -> AuthenticateSubmit2faResponse

DataExports

Types:

from onlyfansapi.types import (
    DataExportCreateResponse,
    DataExportRetrieveResponse,
    DataExportListResponse,
    DataExportCancelResponse,
    DataExportRetryResponse,
    DataExportStartResponse,
)

Methods:

• client.data_exports.create(**params) -> DataExportCreateResponse
• client.data_exports.retrieve(data_export_id, **params) -> DataExportRetrieveResponse
• client.data_exports.list(**params) -> DataExportListResponse
• client.data_exports.cancel(data_export_id) -> DataExportCancelResponse
• client.data_exports.retry(data_export_id) -> DataExportRetryResponse
• client.data_exports.start(data_export_id) -> DataExportStartResponse

Engagement

Messages

Types:

from onlyfansapi.types.engagement import (
    MessageGetMessageBuyersResponse,
    MessageGetTopMessageResponse,
)

Methods:

• client.engagement.messages.get_message_buyers(message_id, *, account, **params) -> MessageGetMessageBuyersResponse
• client.engagement.messages.get_top_message(account, **params) -> MessageGetTopMessageResponse

MassMessages

Types:

from onlyfansapi.types.engagement.messages import MassMessageListResponse, MassMessageChartResponse

Methods:

• client.engagement.messages.mass_messages.list(account, **params) -> MassMessageListResponse
• client.engagement.messages.mass_messages.chart(account, **params) -> MassMessageChartResponse

DirectMessages

Types:

from onlyfansapi.types.engagement.messages import (
    DirectMessageListResponse,
    DirectMessageChartResponse,
)

Methods:

• client.engagement.messages.direct_messages.list(account, **params) -> DirectMessageListResponse
• client.engagement.messages.direct_messages.chart(account, **params) -> DirectMessageChartResponse

Fans

Types:

from onlyfansapi.types import (
    FanGetSubscriptionHistoryResponse,
    FanListActiveResponse,
    FanListAllResponse,
    FanListExpiredResponse,
    FanListLatestResponse,
    FanListTopResponse,
    FanSetCustomNameResponse,
)

Methods:

• client.fans.get_subscription_history(user_id, *, account) -> FanGetSubscriptionHistoryResponse
• client.fans.list_active(account, **params) -> FanListActiveResponse
• client.fans.list_all(account, **params) -> FanListAllResponse
• client.fans.list_expired(account, **params) -> FanListExpiredResponse
• client.fans.list_latest(account, **params) -> FanListLatestResponse
• client.fans.list_top(account, **params) -> FanListTopResponse
• client.fans.set_custom_name(fan_id, *, account, **params) -> FanSetCustomNameResponse

Notes

Types:

from onlyfansapi.types.fans import (
    NoteClearNotesResponse,
    NoteCreateEditNotesResponse,
    NoteGetNotesResponse,
)

Methods:

• client.fans.notes.clear_notes(fan_id, *, account) -> NoteClearNotesResponse
• client.fans.notes.create_edit_notes(fan_id, *, account, **params) -> NoteCreateEditNotesResponse
• client.fans.notes.get_notes(fan_id, *, account) -> NoteGetNotesResponse

Summary

Types:

from onlyfansapi.types.fans import SummaryGenerateSummaryResponse, SummaryGetSummaryResponse

Methods:

• client.fans.summary.generate_summary(fan_id, *, account, **params) -> SummaryGenerateSummaryResponse
• client.fans.summary.get_summary(fan_id, *, account) -> SummaryGetSummaryResponse

Following

Types:

from onlyfansapi.types import (
    FollowingListActiveResponse,
    FollowingListAllResponse,
    FollowingListExpiredResponse,
)

Methods:

• client.following.list_active(account, **params) -> FollowingListActiveResponse
• client.following.list_all(account, **params) -> FollowingListAllResponse
• client.following.list_expired(account, **params) -> FollowingListExpiredResponse

TrialLinks

Types:

from onlyfansapi.types import (
    TrialLinkCreateResponse,
    TrialLinkRetrieveResponse,
    TrialLinkListResponse,
    TrialLinkDeleteResponse,
    TrialLinkListSpendersResponse,
    TrialLinkListSubscribersResponse,
    TrialLinkRetrieveStatsResponse,
)

Methods:

• client.trial_links.create(account, **params) -> TrialLinkCreateResponse
• client.trial_links.retrieve(trial_link_id, *, account) -> TrialLinkRetrieveResponse
• client.trial_links.list(account, **params) -> TrialLinkListResponse
• client.trial_links.delete(trial_link_id, *, account) -> TrialLinkDeleteResponse
• client.trial_links.list_spenders(trial_link_id, *, account, **params) -> TrialLinkListSpendersResponse
• client.trial_links.list_subscribers(trial_link_id, *, account, **params) -> TrialLinkListSubscribersResponse
• client.trial_links.retrieve_cohort_arps(trial_link_id, *, account, **params) -> None
• client.trial_links.retrieve_stats(trial_link_id, *, account, **params) -> TrialLinkRetrieveStatsResponse

Tags

Types:

from onlyfansapi.types.trial_links import TagListResponse, TagAddResponse, TagRemoveResponse

Methods:

• client.trial_links.tags.list(trial_link_id, *, account) -> TagListResponse
• client.trial_links.tags.add(trial_link_id, *, account, **params) -> TagAddResponse
• client.trial_links.tags.remove(trial_link_id, *, account, **params) -> TagRemoveResponse

Giphy

Types:

from onlyfansapi.types import GiphyListTrendingResponse, GiphySearchResponse

Methods:

• client.giphy.list_trending(account, **params) -> GiphyListTrendingResponse
• client.giphy.search(account, **params) -> GiphySearchResponse

LinkTags

Types:

from onlyfansapi.types import LinkTagListResponse

Methods:

• client.link_tags.list(**params) -> LinkTagListResponse

MassMessaging

Types:

from onlyfansapi.types import (
    MassMessagingRetrieveResponse,
    MassMessagingUpdateResponse,
    MassMessagingListResponse,
    MassMessagingDeleteResponse,
    MassMessagingRetrieveOverviewResponse,
    MassMessagingSendResponse,
)

Methods:

• client.mass_messaging.retrieve(id, *, account) -> MassMessagingRetrieveResponse
• client.mass_messaging.update(id, *, account, **params) -> MassMessagingUpdateResponse
• client.mass_messaging.list(account) -> MassMessagingListResponse
• client.mass_messaging.delete(id, *, account) -> MassMessagingDeleteResponse
• client.mass_messaging.retrieve_overview(account, **params) -> MassMessagingRetrieveOverviewResponse
• client.mass_messaging.send(account, **params) -> MassMessagingSendResponse

Media

Types:

from onlyfansapi.types import MediaDownloadResponse, MediaScrapeResponse, MediaUploadResponse

Methods:

• client.media.download(cdn_url, *, account) -> str
• client.media.scrape(account, **params) -> MediaScrapeResponse
• client.media.upload(account, **params) -> MediaUploadResponse

Uploads

Types:

from onlyfansapi.types.media import UploadGetStatusResponse

Methods:

• client.media.uploads.get_status(upload, *, account) -> UploadGetStatusResponse

Vault

Types:

from onlyfansapi.types.media import (
    VaultRetrieveResponse,
    VaultListResponse,
    VaultDeleteResponse,
    VaultUploadResponse,
)

Methods:

• client.media.vault.retrieve(media_id, *, account) -> VaultRetrieveResponse
• client.media.vault.list(account, **params) -> VaultListResponse
• client.media.vault.delete(account, **params) -> VaultDeleteResponse
• client.media.vault.upload(account, **params) -> VaultUploadResponse

Lists

Types:

from onlyfansapi.types.media.vault import (
    ListCreateResponse,
    ListRetrieveResponse,
    ListUpdateResponse,
    ListListResponse,
    ListDeleteResponse,
)

Methods:

• client.media.vault.lists.create(account, **params) -> ListCreateResponse
• client.media.vault.lists.retrieve(list_id, *, account) -> ListRetrieveResponse
• client.media.vault.lists.update(list_id, *, account) -> ListUpdateResponse
• client.media.vault.lists.list(account, **params) -> ListListResponse
• client.media.vault.lists.delete(list_id, *, account) -> ListDeleteResponse

Media

Types:

from onlyfansapi.types.media.vault.lists import MediaAddResponse, MediaRemoveResponse

Methods:

• client.media.vault.lists.media.add(list_id, *, account, **params) -> MediaAddResponse
• client.media.vault.lists.media.remove(list_id, *, account, **params) -> MediaRemoveResponse

Notifications

Types:

from onlyfansapi.types import (
    NotificationListResponse,
    NotificationGetCountsResponse,
    NotificationMarkAllAsReadResponse,
    NotificationSearchUsersResponse,
)

Methods:

• client.notifications.list(account, **params) -> NotificationListResponse
• client.notifications.get_counts(account) -> NotificationGetCountsResponse
• client.notifications.mark_all_as_read(account) -> NotificationMarkAllAsReadResponse
• client.notifications.search_users(account, **params) -> NotificationSearchUsersResponse

TabsOrder

Types:

from onlyfansapi.types.notifications import TabsOrderUpdateResponse, TabsOrderGetResponse

Methods:

• client.notifications.tabs_order.update(account, **params) -> TabsOrderUpdateResponse
• client.notifications.tabs_order.get(account) -> TabsOrderGetResponse

Payouts

Types:

from onlyfansapi.types import (
    PayoutListRequestsResponse,
    PayoutRequestManualWithdrawalResponse,
    PayoutRetrieveBalancesResponse,
    PayoutRetrieveEarningStatisticsResponse,
    PayoutRetrieveEligibilityResponse,
    PayoutUpdateFrequencyResponse,
)

Methods:

• client.payouts.list_requests(account, **params) -> PayoutListRequestsResponse
• client.payouts.request_manual_withdrawal(account, **params) -> PayoutRequestManualWithdrawalResponse
• client.payouts.retrieve_balances(account) -> PayoutRetrieveBalancesResponse
• client.payouts.retrieve_earning_statistics(account, **params) -> PayoutRetrieveEarningStatisticsResponse
• client.payouts.retrieve_eligibility(account) -> PayoutRetrieveEligibilityResponse
• client.payouts.update_frequency(account, **params) -> PayoutUpdateFrequencyResponse

Posts

Types:

from onlyfansapi.types import (
    PostCreateResponse,
    PostRetrieveResponse,
    PostUpdateResponse,
    PostListResponse,
    PostDeleteResponse,
    PostArchiveResponse,
    PostPinResponse,
    PostStatsResponse,
    PostUnarchiveResponse,
)

Methods:

• client.posts.create(account, **params) -> PostCreateResponse
• client.posts.retrieve(post_id, *, account) -> PostRetrieveResponse
• client.posts.update(post_id, *, account, **params) -> str
• client.posts.list(account, **params) -> PostListResponse
• client.posts.delete(post_id, *, account) -> PostDeleteResponse
• client.posts.archive(post_id, *, account, **params) -> PostArchiveResponse
• client.posts.pin(post_id, *, account) -> PostPinResponse
• client.posts.stats(post_id, *, account, **params) -> PostStatsResponse
• client.posts.unarchive(post_id, *, account, **params) -> PostUnarchiveResponse

Comments

Types:

from onlyfansapi.types.posts import (
    CommentCreateResponse,
    CommentListResponse,
    CommentDeleteResponse,
    CommentLikeResponse,
    CommentPinResponse,
    CommentUnlikeResponse,
    CommentUnpinResponse,
)

Methods:

• client.posts.comments.create(post_id, *, account, **params) -> CommentCreateResponse
• client.posts.comments.list(post_id, *, account, **params) -> CommentListResponse
• client.posts.comments.delete(comment_id, *, account, post_id) -> CommentDeleteResponse
• client.posts.comments.like(comment_id, *, account, post_id) -> CommentLikeResponse
• client.posts.comments.pin(comment_id, *, account, post_id) -> CommentPinResponse
• client.posts.comments.unlike(comment_id, *, account, post_id) -> CommentUnlikeResponse
• client.posts.comments.unpin(comment_id, *, account, post_id) -> CommentUnpinResponse

Labels

Types:

from onlyfansapi.types.posts import LabelCreateResponse, LabelListResponse

Methods:

• client.posts.labels.create(account, **params) -> LabelCreateResponse
• client.posts.labels.list(account, **params) -> LabelListResponse

Promotions

Types:

from onlyfansapi.types import (
    PromotionCreateResponse,
    PromotionListResponse,
    PromotionDeleteResponse,
    PromotionStopResponse,
)

Methods:

• client.promotions.create(account, **params) -> PromotionCreateResponse
• client.promotions.list(account, **params) -> PromotionListResponse
• client.promotions.delete(promotion_id, *, account) -> PromotionDeleteResponse
• client.promotions.stop(promotion_id, *, account) -> PromotionStopResponse

Profiles

Types:

from onlyfansapi.types import ProfileRetrieveResponse

Methods:

• client.profiles.retrieve(username, **params) -> ProfileRetrieveResponse

Search

Types:

from onlyfansapi.types import SearchProfilesResponse

Methods:

• client.search.profiles(**params) -> SearchProfilesResponse

Queue

Types:

from onlyfansapi.types import QueueListResponse, QueueCountResponse, QueuePublishResponse

Methods:

• client.queue.list(account, **params) -> QueueListResponse
• client.queue.count(account, **params) -> QueueCountResponse
• client.queue.publish(queue_id, *, account) -> QueuePublishResponse

ReleaseForms

Types:

from onlyfansapi.types import (
    ReleaseFormCreateInvitationLinkResponse,
    ReleaseFormCreateReleaseFormResponse,
    ReleaseFormListTaggableUsersResponse,
)

Methods:

• client.release_forms.create_invitation_link(account, **params) -> ReleaseFormCreateInvitationLinkResponse
• client.release_forms.create_release_form(account, **params) -> ReleaseFormCreateReleaseFormResponse
• client.release_forms.list_taggable_users(account, **params) -> ReleaseFormListTaggableUsersResponse

SavedForLater

Messages

Types:

from onlyfansapi.types.saved_for_later import MessageListResponse

Methods:

• client.saved_for_later.messages.list(account, **params) -> MessageListResponse

Settings

Types:

from onlyfansapi.types.saved_for_later.messages import (
    SettingRetrieveResponse,
    SettingDisableAutomaticMessagingResponse,
    SettingEnableOrUpdateAutomaticMessagingResponse,
)

Methods:

• client.saved_for_later.messages.settings.retrieve(account) -> SettingRetrieveResponse
• client.saved_for_later.messages.settings.disable_automatic_messaging(account) -> SettingDisableAutomaticMessagingResponse
• client.saved_for_later.messages.settings.enable_or_update_automatic_messaging(account, **params) -> SettingEnableOrUpdateAutomaticMessagingResponse

Posts

Types:

from onlyfansapi.types.saved_for_later import PostListResponse

Methods:

• client.saved_for_later.posts.list(account, **params) -> PostListResponse

Settings

Types:

from onlyfansapi.types.saved_for_later.posts import (
    SettingRetrieveResponse,
    SettingDisableAutomaticPostingResponse,
    SettingEnableOrUpdateAutomaticPostingResponse,
)

Methods:

• client.saved_for_later.posts.settings.retrieve(account) -> SettingRetrieveResponse
• client.saved_for_later.posts.settings.disable_automatic_posting(account) -> SettingDisableAutomaticPostingResponse
• client.saved_for_later.posts.settings.enable_or_update_automatic_posting(account, **params) -> SettingEnableOrUpdateAutomaticPostingResponse

Settings

Types:

from onlyfansapi.types import (
    SettingRetrieveResponse,
    SettingCheckUsernameAvailabilityResponse,
    SettingUpdateProfileResponse,
    SettingUpdateSubscriptionPriceResponse,
)

Methods:

• client.settings.retrieve(account) -> SettingRetrieveResponse
• client.settings.check_username_availability(account, **params) -> SettingCheckUsernameAvailabilityResponse
• client.settings.update_profile(account, **params) -> SettingUpdateProfileResponse
• client.settings.update_subscription_price(account, **params) -> SettingUpdateSubscriptionPriceResponse

BlockedCountries

Types:

from onlyfansapi.types.settings import BlockedCountryRetrieveResponse, BlockedCountryUpdateResponse

Methods:

• client.settings.blocked_countries.retrieve(account) -> BlockedCountryRetrieveResponse
• client.settings.blocked_countries.update(account, **params) -> BlockedCountryUpdateResponse

WelcomeMessage

Types:

from onlyfansapi.types.settings import (
    WelcomeMessageRetrieveResponse,
    WelcomeMessageUpdateResponse,
    WelcomeMessageToggleResponse,
)

Methods:

• client.settings.welcome_message.retrieve(account) -> WelcomeMessageRetrieveResponse
• client.settings.welcome_message.update(account, **params) -> WelcomeMessageUpdateResponse
• client.settings.welcome_message.toggle(account, **params) -> WelcomeMessageToggleResponse

SocialMediaButtons

Types:

from onlyfansapi.types.settings import (
    SocialMediaButtonUpdateResponse,
    SocialMediaButtonListResponse,
    SocialMediaButtonDeleteResponse,
    SocialMediaButtonAddResponse,
    SocialMediaButtonReorderResponse,
)

Methods:

• client.settings.social_media_buttons.update(button_id, *, account, **params) -> SocialMediaButtonUpdateResponse
• client.settings.social_media_buttons.list(account) -> SocialMediaButtonListResponse
• client.settings.social_media_buttons.delete(button_id, *, account) -> SocialMediaButtonDeleteResponse
• client.settings.social_media_buttons.add(account, **params) -> SocialMediaButtonAddResponse
• client.settings.social_media_buttons.reorder(account, **params) -> SocialMediaButtonReorderResponse

SharedTrialLinks

Types:

from onlyfansapi.types import SharedTrialLinkListResponse, SharedTrialLinkRevokeAccessResponse

Methods:

• client.shared_trial_links.list(account, **params) -> SharedTrialLinkListResponse
• client.shared_trial_links.revoke_access(shared_trial_link_id, *, account) -> SharedTrialLinkRevokeAccessResponse

Tags

Types:

from onlyfansapi.types.shared_trial_links import TagListResponse, TagAddResponse, TagRemoveResponse

Methods:

• client.shared_trial_links.tags.list(shared_trial_link_id, *, account) -> TagListResponse
• client.shared_trial_links.tags.add(shared_trial_link_id, *, account, **params) -> TagAddResponse
• client.shared_trial_links.tags.remove(shared_trial_link_id, *, account, **params) -> TagRemoveResponse

SharedTrackingLinks

Types:

from onlyfansapi.types import SharedTrackingLinkListResponse, SharedTrackingLinkRevokeAccessResponse

Methods:

• client.shared_tracking_links.list(account, **params) -> SharedTrackingLinkListResponse
• client.shared_tracking_links.revoke_access(shared_tracking_link_id, *, account) -> SharedTrackingLinkRevokeAccessResponse

Tags

Types:

from onlyfansapi.types.shared_tracking_links import (
    TagListResponse,
    TagAddResponse,
    TagRemoveResponse,
)

Methods:

• client.shared_tracking_links.tags.list(shared_tracking_link_id, *, account) -> TagListResponse
• client.shared_tracking_links.tags.add(shared_tracking_link_id, *, account, **params) -> TagAddResponse
• client.shared_tracking_links.tags.remove(shared_tracking_link_id, *, account, **params) -> TagRemoveResponse

SmartLinkPostbacks

Types:

from onlyfansapi.types import (
    SmartLinkPostbackCreateResponse,
    SmartLinkPostbackRetrieveResponse,
    SmartLinkPostbackUpdateResponse,
    SmartLinkPostbackListResponse,
    SmartLinkPostbackDeleteResponse,
)

Methods:

• client.smart_link_postbacks.create(**params) -> SmartLinkPostbackCreateResponse
• client.smart_link_postbacks.retrieve(postback_id) -> SmartLinkPostbackRetrieveResponse
• client.smart_link_postbacks.update(postback_id, **params) -> SmartLinkPostbackUpdateResponse
• client.smart_link_postbacks.list() -> SmartLinkPostbackListResponse
• client.smart_link_postbacks.delete(postback_id) -> Optional[SmartLinkPostbackDeleteResponse]

SmartLinks

Types:

from onlyfansapi.types import (
    SmartLinkCreateResponse,
    SmartLinkRetrieveResponse,
    SmartLinkListResponse,
    SmartLinkDeleteResponse,
    SmartLinkListClicksResponse,
    SmartLinkListConversionsResponse,
    SmartLinkListFansResponse,
    SmartLinkListSpendersResponse,
    SmartLinkRetrieveStatsResponse,
)

Methods:

• client.smart_links.create(**params) -> SmartLinkCreateResponse
• client.smart_links.retrieve(smart_link_id) -> SmartLinkRetrieveResponse
• client.smart_links.list(**params) -> SmartLinkListResponse
• client.smart_links.delete(smart_link_id) -> SmartLinkDeleteResponse
• client.smart_links.list_clicks(smart_link_id, **params) -> SmartLinkListClicksResponse
• client.smart_links.list_conversions(smart_link_id, **params) -> SmartLinkListConversionsResponse
• client.smart_links.list_fans(smart_link_id, **params) -> SmartLinkListFansResponse
• client.smart_links.list_spenders(smart_link_id, **params) -> SmartLinkListSpendersResponse
• client.smart_links.retrieve_cohort_arps(smart_link_id, **params) -> None
• client.smart_links.retrieve_stats(smart_link_id, **params) -> SmartLinkRetrieveStatsResponse

Statistics

Types:

from onlyfansapi.types import (
    StatisticCalculateTotalTransactionsResponse,
    StatisticGetOverviewResponse,
    StatisticGetSubscriberMetricsResponse,
)

Methods:

• client.statistics.calculate_total_transactions(account, **params) -> StatisticCalculateTotalTransactionsResponse
• client.statistics.get_overview(account, **params) -> StatisticGetOverviewResponse
• client.statistics.get_subscriber_metrics(account, **params) -> StatisticGetSubscriberMetricsResponse

Statements

Types:

from onlyfansapi.types.statistics import StatementGetEarningsResponse

Methods:

• client.statistics.statements.get_earnings(account, **params) -> StatementGetEarningsResponse

Reach

Types:

from onlyfansapi.types.statistics import ReachGetProfileVisitorsResponse

Methods:

• client.statistics.reach.get_profile_visitors(account, **params) -> ReachGetProfileVisitorsResponse

Subscribers

Types:

from onlyfansapi.types import SubscriberRetrieveStatisticsResponse

Methods:

• client.subscribers.retrieve_statistics(account, **params) -> SubscriberRetrieveStatisticsResponse

Stored

Types:

from onlyfansapi.types import (
    StoredListSharedTrackingLinksResponse,
    StoredListSharedTrialLinksResponse,
    StoredListTrackingLinksResponse,
    StoredListTrialLinksResponse,
)

Methods:

• client.stored.list_shared_tracking_links(account, **params) -> StoredListSharedTrackingLinksResponse
• client.stored.list_shared_trial_links(account, **params) -> StoredListSharedTrialLinksResponse
• client.stored.list_tracking_links(account, **params) -> StoredListTrackingLinksResponse
• client.stored.list_trial_links(account, **params) -> StoredListTrialLinksResponse

Stories

Types:

from onlyfansapi.types import (
    StoryCreateResponse,
    StoryRetrieveResponse,
    StoryDeleteResponse,
    StoryListActiveResponse,
    StoryListArchiveResponse,
    StoryListViewersResponse,
    StoryMarkAsWatchedResponse,
    StoryRetrieveStatsResponse,
)

Methods:

• client.stories.create(account, **params) -> StoryCreateResponse
• client.stories.retrieve(story_id, *, account) -> StoryRetrieveResponse
• client.stories.delete(story_id, *, account) -> StoryDeleteResponse
• client.stories.list_active(account) -> StoryListActiveResponse
• client.stories.list_archive(account, **params) -> StoryListArchiveResponse
• client.stories.list_viewers(story_id, *, account, **params) -> StoryListViewersResponse
• client.stories.mark_as_watched(story_id, *, account) -> StoryMarkAsWatchedResponse
• client.stories.retrieve_stats(story_id, *, account) -> StoryRetrieveStatsResponse

Highlights

Types:

from onlyfansapi.types.stories import (
    HighlightCreateResponse,
    HighlightRetrieveResponse,
    HighlightUpdateResponse,
    HighlightListResponse,
    HighlightDeleteResponse,
    HighlightAddStoryResponse,
    HighlightRemoveStoryResponse,
)

Methods:

• client.stories.highlights.create(account, **params) -> HighlightCreateResponse
• client.stories.highlights.retrieve(highlight_id, *, account) -> HighlightRetrieveResponse
• client.stories.highlights.update(highlight_id, *, account, **params) -> HighlightUpdateResponse
• client.stories.highlights.list(account, **params) -> HighlightListResponse
• client.stories.highlights.delete(highlight_id, *, account) -> HighlightDeleteResponse
• client.stories.highlights.add_story(path_story_id, *, account, highlight_id, **params) -> HighlightAddStoryResponse
• client.stories.highlights.remove_story(story_id, *, account, highlight_id) -> HighlightRemoveStoryResponse

Bundles

Types:

from onlyfansapi.types import BundleCreateResponse, BundleListResponse, BundleDeleteResponse

Methods:

• client.bundles.create(account, **params) -> BundleCreateResponse
• client.bundles.list(account) -> BundleListResponse
• client.bundles.delete(bundle_id, *, account) -> BundleDeleteResponse

TrackingLinks

Types:

from onlyfansapi.types import (
    TrackingLinkCreateResponse,
    TrackingLinkRetrieveResponse,
    TrackingLinkListResponse,
    TrackingLinkDeleteResponse,
    TrackingLinkGetStatsResponse,
    TrackingLinkListSpendersResponse,
    TrackingLinkListSubscribersResponse,
)

Methods:

• client.tracking_links.create(account, **params) -> TrackingLinkCreateResponse
• client.tracking_links.retrieve(tracking_link_id, *, account) -> TrackingLinkRetrieveResponse
• client.tracking_links.list(account, **params) -> TrackingLinkListResponse
• client.tracking_links.delete(tracking_link_id, *, account) -> TrackingLinkDeleteResponse
• client.tracking_links.get_cohort_arps(tracking_link_id, *, account, **params) -> None
• client.tracking_links.get_stats(tracking_link_id, *, account, **params) -> TrackingLinkGetStatsResponse
• client.tracking_links.list_spenders(tracking_link_id, *, account, **params) -> TrackingLinkListSpendersResponse
• client.tracking_links.list_subscribers(tracking_link_id, *, account, **params) -> TrackingLinkListSubscribersResponse

Tags

Types:

from onlyfansapi.types.tracking_links import TagListResponse, TagAddResponse, TagRemoveResponse

Methods:

• client.tracking_links.tags.list(tracking_link_id, *, account) -> TagListResponse
• client.tracking_links.tags.add(tracking_link_id, *, account, **params) -> TagAddResponse
• client.tracking_links.tags.remove(tracking_link_id, *, account, **params) -> TagRemoveResponse

Transactions

Types:

from onlyfansapi.types import TransactionListResponse

Methods:

• client.transactions.list(account, **params) -> TransactionListResponse

UserLists

Types:

from onlyfansapi.types import (
    UserListCreateResponse,
    UserListRetrieveResponse,
    UserListUpdateResponse,
    UserListListResponse,
    UserListDeleteResponse,
)

Methods:

• client.user_lists.create(account, **params) -> UserListCreateResponse
• client.user_lists.retrieve(user_list_id, *, account) -> UserListRetrieveResponse
• client.user_lists.update(user_list_id, *, account, **params) -> UserListUpdateResponse
• client.user_lists.list(account, **params) -> UserListListResponse
• client.user_lists.delete(user_list_id, *, account) -> UserListDeleteResponse

Users

Types:

from onlyfansapi.types.user_lists import (
    UserListResponse,
    UserAddResponse,
    UserClearResponse,
    UserListPinnedResponse,
    UserPinResponse,
    UserRemoveResponse,
)

Methods:

• client.user_lists.users.list(user_list_id, *, account, **params) -> UserListResponse
• client.user_lists.users.add(user_list_id, *, account, **params) -> UserAddResponse
• client.user_lists.users.clear(user_list_id, *, account) -> UserClearResponse
• client.user_lists.users.list_pinned(user_list_id, *, account, **params) -> UserListPinnedResponse
• client.user_lists.users.pin(user_id, *, account, user_list_id) -> UserPinResponse
• client.user_lists.users.remove(user_id, *, account, user_list_id) -> UserRemoveResponse

Users

Types:

from onlyfansapi.types import UserRetrieveResponse, UserListResponse

Methods:

• client.users.retrieve(username, *, account) -> UserRetrieveResponse
• client.users.list(account, **params) -> UserListResponse

Restrict

Types:

from onlyfansapi.types.users import RestrictCreateResponse, RestrictDeleteResponse

Methods:

• client.users.restrict.create(user_id, *, account) -> RestrictCreateResponse
• client.users.restrict.delete(user_id, *, account) -> RestrictDeleteResponse

Block

Types:

from onlyfansapi.types.users import BlockCreateResponse, BlockDeleteResponse

Methods:

• client.users.block.create(user_id, *, account) -> BlockCreateResponse
• client.users.block.delete(user_id, *, account) -> BlockDeleteResponse

Subscribe

Types:

from onlyfansapi.types.users import SubscribeCreateResponse, SubscribeDeleteResponse

Methods:

• client.users.subscribe.create(user_id, *, account) -> SubscribeCreateResponse
• client.users.subscribe.delete(user_id, *, account, **params) -> SubscribeDeleteResponse

Webhooks

Types:

from onlyfansapi.types import (
    WebhookCreateResponse,
    WebhookRetrieveResponse,
    WebhookUpdateResponse,
    WebhookListResponse,
    WebhookDeleteResponse,
    WebhookListEventsResponse,
)

Methods:

• client.webhooks.create(**params) -> WebhookCreateResponse
• client.webhooks.retrieve(webhook_id) -> WebhookRetrieveResponse
• client.webhooks.update(webhook_id, **params) -> WebhookUpdateResponse
• client.webhooks.list() -> WebhookListResponse
• client.webhooks.delete(webhook_id) -> Optional[WebhookDeleteResponse]
• client.webhooks.list_events() -> WebhookListEventsResponse