mastodon_client library
Mastodon API client library
Classes
- FunctionLogger
- Lightweight wrapper that adapts a function-based logger to the Logger interface.
- Logger
- Logger interface used internally by the library.
- MastodonAccount
- Mastodon account (user) model.
- MastodonAccountCreateRequest
- Parameters for an account registration request.
- MastodonAccountsConfiguration
-
Account limits (
configuration.accounts). - MastodonAccountSource
- Default posting settings and private information of the authenticated user.
- MastodonAccountWarning
- Moderation warning (Mastodon 4.3+).
- MastodonAdminAccount
- Admin-level account information.
- MastodonAdminAccountActionRequest
- Request for performing an admin account action.
- MastodonAdminCanonicalEmailBlock
- Admin-level canonical email block information.
- MastodonAdminCohort
- Admin-level retention cohort data.
- MastodonAdminCohortData
- Individual retention data entry for a cohort.
- MastodonAdminDimension
- Admin-level dimension (qualitative) data.
- MastodonAdminDimensionData
- Individual data entry for a dimension.
- MastodonAdminDimensionRequest
- Request for fetching admin dimension data.
- MastodonAdminDomainAllow
- Admin-level domain allow information.
- MastodonAdminDomainBlock
- Admin-level domain block information.
- MastodonAdminDomainBlockRequest
- Request for creating or updating an admin domain block.
- MastodonAdminEmailDomainBlock
- Admin-level email domain block information.
- MastodonAdminEmailDomainBlockHistory
- Daily usage statistics for an email domain block.
- MastodonAdminIp
- Admin-level IP address information.
- MastodonAdminIpBlock
- Admin-level IP block information.
- MastodonAdminIpBlockCreateRequest
- Request for creating an admin IP block.
- MastodonAdminIpBlockUpdateRequest
- Request for updating an admin IP block.
- MastodonAdminMeasure
- Admin-level measure (quantitative) data.
- MastodonAdminMeasureData
- Daily data entry for a measure.
- MastodonAdminMeasureRequest
- Request for fetching admin measure data.
- MastodonAdminPreviewCardProvider
- Admin-level preview card provider.
- MastodonAdminReport
- Admin-level report information.
- MastodonAdminReportUpdateRequest
- Request for updating an admin report.
- MastodonAdminRetentionRequest
- Request for fetching admin retention data.
- MastodonAdminRole
- Admin-level role information.
- MastodonAdminTag
- Admin-level hashtag information.
- MastodonAdminTrendsLink
- Admin-level trending link.
- MastodonAnnouncement
- Server announcement.
- MastodonAnnouncementReaction
- Reaction to an announcement.
- MastodonAnnouncementStatus
- Status referenced in an announcement body.
- MastodonApplication
- OAuth application information model.
- MastodonAsyncRefresh
- Status of an asynchronous refresh operation (experimental).
- MastodonClient
- Main entry point for the Mastodon API client.
- MastodonConversation
- Direct message conversation.
- MastodonCredentialAccount
- Account information of the authenticated user.
- MastodonCredentialAccountUpdateRequest
- Parameters for a profile update request.
- MastodonCredentialApplication
- OAuth application registration response model.
- MastodonCustomEmoji
- Custom emoji on Mastodon.
- MastodonDomainBlock
- Information about a domain blocked by the instance.
- MastodonExtendedDescription
- Extended description of the instance.
- MastodonFamiliarFollowers
- List of accounts you follow that also follow the specified account.
- MastodonFeaturedTag
- Hashtag featured on an account's profile.
- MastodonField
- Profile field of a Mastodon account.
- MastodonFieldAttribute
- Custom profile field attribute.
- MastodonFilter
- Filter group (v2, Mastodon 4.0+).
- MastodonFilterKeyword
- Filter keyword.
- MastodonFilterKeywordParam
- Keyword parameter for filter creation.
- MastodonFilterKeywordUpdateParam
- Keyword parameter for filter updates.
- MastodonFilterStatus
- Status filter.
- MastodonFilterV1
- v1 filter (deprecated, scheduled for removal in Mastodon 4.0).
- MastodonGroupedNotificationsResults
- Response from the grouped notifications API.
- MastodonIdentityProof
- Identity proof information for an account.
- MastodonInstance
- Mastodon instance information.
- MastodonInstanceConfiguration
-
Instance configuration and limits (
configuration). - MastodonInstanceContact
-
Contact information for the instance (
contact). - MastodonInstanceIcon
-
Instance icon image (
icon, Mastodon 4.3+). - MastodonInstanceRegistrations
-
Registration settings for the instance (
registrations). - MastodonInstanceRule
-
Instance rule (
rules). - MastodonInstanceRuleTranslation
-
Translation of an instance rule (
rules[].translations). - MastodonInstanceThumbnail
-
Thumbnail image information for the instance (
thumbnail). - MastodonInstanceThumbnailVersions
-
Resolution-specific thumbnail versions (
thumbnail.versions). - MastodonInstanceUrls
-
URL settings for the instance (
configuration.urls). - MastodonInstanceUsage
-
Usage statistics of the instance (
usage). - MastodonInstanceV1
- Mastodon instance information in v1 format.
- MastodonInstanceV1Configuration
- v1 instance configuration.
- MastodonInstanceV1Stats
- v1 instance statistics.
- MastodonInstanceV1Urls
- v1 instance URL settings.
- MastodonList
- User-defined list.
- MastodonMarker
- Timeline read position marker model.
- MastodonMediaAttachment
- Media attachment on Mastodon.
- MastodonMediaAttributeRequest
- Media attribute parameters for status editing.
- MastodonMediaConfiguration
-
Media attachment limits (
configuration.media_attachments). - MastodonMention
-
Mention (the
@usernameportion within a status). - MastodonNotification
- Mastodon notification.
- MastodonNotificationGroup
- Grouped notification.
- MastodonNotificationPolicy
- Mastodon notification policy (Mastodon 4.3+).
- MastodonNotificationPolicySummary
- Summary of a notification policy.
- MastodonNotificationRequest
- Filtered notification request (Mastodon 4.3+).
- MastodonOAuthServerMetadata
- OAuth authorization server metadata model.
- MastodonOAuthUserInfo
- OAuth userinfo endpoint response model.
- MastodonOEmbed
- OEmbed metadata for Mastodon.
-
MastodonPage<
T> - Generic model representing a paginated list result.
- MastodonPartialAccount
- Partial account information.
- MastodonPoll
- Mastodon poll.
- MastodonPollCreateRequest
- Poll parameters for status creation.
- MastodonPollEditRequest
- Poll parameters for status editing.
- MastodonPollOption
- Poll option.
- MastodonPollsConfiguration
-
Poll limits (
configuration.polls). - MastodonPreferences
- User account preferences model.
- MastodonPreviewCard
- Preview card for a link.
- MastodonPreviewCardAuthor
- Author information for a preview card (Mastodon 4.3.0+).
- MastodonPrivacyPolicy
- Privacy policy of the instance.
- MastodonProof
- Proof information returned by an identity verification provider.
- MastodonProofSignature
- Signature information for an identity proof.
- MastodonPushAlerts
- Alert settings per Web Push notification type.
- MastodonPushAlertSettings
- Alert settings per Web Push notification type (for requests).
- MastodonPushSubscriptionRequest
- Web Push subscription creation request.
- MastodonPushSubscriptionUpdateRequest
- Web Push subscription update request.
- MastodonRelationship
- Relationship between two accounts (follow, block, mute, etc.).
- MastodonRelationshipSeveranceEvent
- Relationship severance event (Mastodon 4.3+).
- MastodonReport
- Report entity.
- MastodonReportCreateRequest
- Request for creating a report.
- MastodonRole
- User role information.
- MastodonScheduledStatus
- Scheduled status model.
- MastodonScheduledStatusParams
- Parameters of a scheduled status.
- MastodonScheduledStatusPoll
- Poll parameters of a scheduled status.
- MastodonSearchResult
- v2 search result.
- MastodonSearchResultV1
- v1 search result (deprecated).
- MastodonStatus
- Mastodon status (post).
- MastodonStatusContext
- Context of a status (ancestors and descendants).
- MastodonStatusCreated
- Result of an immediate post.
- MastodonStatusCreateRequest
- Parameters for a status creation request.
- MastodonStatusCreateResult
- Sealed class representing the response from the status creation API.
- MastodonStatusEdit
- Revision of a status edit.
- MastodonStatusEditPoll
- Poll snapshot within the edit history.
- MastodonStatusEditPollOption
- Poll option within the edit history.
- MastodonStatusEditRequest
- Parameters for a status edit request.
- MastodonStatusesConfiguration
-
Status posting limits (
configuration.statuses). - MastodonStatusScheduled
- Result of a scheduled post.
- MastodonStatusSource
- Source information of a status.
- MastodonSuggestion
- Suggested account to follow and the reason for the suggestion.
- MastodonTag
- Hashtag information model.
- MastodonTagHistory
- Daily usage statistics for a hashtag.
- MastodonTermsOfService
- Terms of service of the instance.
- MastodonTimelineHashtagFeeds
- Access settings for hashtag feeds.
- MastodonTimelineLiveFeeds
- Access settings for live feeds (real-time timelines).
- MastodonTimelinesAccess
-
Timeline access settings for the instance
(
configuration.timelines_access). - MastodonToken
- OAuth access token.
- MastodonTranslation
- Translation result of a status.
- MastodonTranslationAttachment
- Media attachment information within a translation result.
- MastodonTranslationPoll
- Poll information within a translation result.
- MastodonTranslationPollOption
- Poll option within a translation result.
- MastodonTrendsLink
- Trending link.
- MastodonTrendsLinkHistory
- Daily usage statistics for a trending link.
- MastodonUnreadNotificationCount
- Unread notification count (Mastodon 4.3+).
- MastodonWebPushSubscription
- Mastodon Web Push subscription.
- MastodonWeeklyActivity
- Weekly activity statistics of the instance.
- StdoutLogger
- Default Logger implementation that outputs logs to stdout.
Enums
- MastodonAdminDomainBlockSeverity
- Severity level of an admin domain block.
- MastodonAdminIpBlockSeverity
- Severity level of an IP block.
- MastodonDomainBlockSeverity
- Severity level of a domain block.
- MastodonFilterAction
- Filter action type (v2).
- MastodonMediaType
- Type of media.
- MastodonNotificationType
- Type of notification.
- MastodonPreviewCardType
- Type of preview card.
- MastodonTimelineAccessLevel
- Public access level of a timeline.
- MastodonVisibility
- Visibility of a status.
- NotificationFilterAction
- Filtering action for a notification policy.
Exceptions / Errors
- MastodonAlreadyVotedException
- Already voted error (HTTP 422 -- already voted).
- MastodonApiException
- Exception representing an HTTP response error.
- MastodonAuthCancelledException
- The user cancelled the authentication.
- MastodonAuthException
- Base class for errors during the OAuth authentication flow.
- MastodonAuthStateMismatchException
- OAuth state parameter mismatch (CSRF detected).
- MastodonAuthTokenException
- Failed to obtain an access token.
- MastodonException
- Base class for exceptions thrown by the Mastodon API client.
- MastodonForbiddenException
- Permission error (HTTP 403).
- MastodonMediaProcessingTimeoutException
- Media async processing timeout.
- MastodonNetworkException
- Network connection error (timeout, connection refused, etc.).
- MastodonNotFoundException
- Resource not found (HTTP 404).
- MastodonRateLimitException
- Rate limit error (HTTP 429).
- MastodonServerException
- Server error (HTTP 5xx).
- Authentication error (HTTP 401).
- MastodonValidationException
- Validation error (HTTP 422).