mirror
/
Mastodon.py
kopia lustrzana https://github.com/halcy/Mastodon.py
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność
Mastodon.py/srcgen/return_types_all_current_fi...

7836 wiersze
284 KiB
JSON
Czysty Bezpośredni odnośnik Wina Historia

[
{
"name": "User / account",
"python_name": "Account",
"func_call": "mastodon.account(<account id>)",
"func_call_real": "mastodon.account(23972)",
"func_call_additional": "mastodon.account_verify_credentials()",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Account/",
"func_alternate_acc": false,
"manual_update": false,
"description": "A user acccount, local or remote.",
"fields": {
"id": {
"description": "The accounts id",
"field_type": "MaybeSnowflakeIdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.1.0",
"added"
]
],
"enum": null
},
"username": {
"description": "The username, without the domain part",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.1.0",
"added"
]
],
"enum": null
},
"acct": {
"description": "The user's account name as username@domain (@domain omitted for local users)",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.1.0",
"added"
]
],
"enum": null
},
"display_name": {
"description": "The user's display name",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.1.0",
"added"
]
],
"enum": null
},
"discoverable": {
"description": "Indicates whether or not a user is visible on the discovery page",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"3.1.0",
"added"
]
],
"enum": null
},
"group": {
"description": "A boolean indicating whether the account represents a group rather than an individual.",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.1.0",
"added"
]
],
"enum": null
},
"locked": {
"description": "Denotes whether the account can be followed without a follow request",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.1.0",
"added"
]
],
"enum": null
},
"created_at": {
"description": "The accounts creation time",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.1.0",
"added"
],
[
"3.4.0",
"now resolves to midnight instead of an exact time"
]
],
"enum": null
},
"following_count": {
"description": "How many accounts this account follows",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.1.0",
"added"
]
],
"enum": null
},
"followers_count": {
"description": "How many followers this account has",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.1.0",
"added"
]
],
"enum": null
},
"statuses_count": {
"description": "How many statuses this account has created, excluding: 1) later deleted posts 2) direct messages / 'mentined users only' posts, except in earlier versions mastodon.",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.1.0",
"added"
],
[
"2.4.2",
"no longer includes direct / mentioned-only visibility statuses"
]
],
"enum": null
},
"note": {
"description": "The users bio / profile text / 'note'",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.1.0",
"added"
]
],
"enum": null
},
"url": {
"description": "A URL pointing to this users profile page (can be remote)",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "URL",
"version_history": [
[
"0.1.0",
"added"
]
],
"enum": null
},
"avatar": {
"description": "URL for this users avatar, can be animated",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "URL",
"version_history": [
[
"0.1.0",
"added"
]
],
"enum": null
},
"header": {
"description": "URL for this users header image, can be animated",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "URL",
"version_history": [
[
"0.1.0",
"added"
]
],
"enum": null
},
"avatar_static": {
"description": "URL for this users avatar, never animated",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "URL",
"version_history": [
[
"1.1.2",
"added"
]
],
"enum": null
},
"header_static": {
"description": "URL for this users header image, never animated",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "URL",
"version_history": [
[
"1.1.2",
"added"
]
],
"enum": null
},
"moved_to_account": {
"description": "If set, Account that this user has set up as their moved-to address.",
"field_type": "Account",
"field_subtype": null,
"is_optional": true,
"is_nullable": false,
"version_history": [
[
"2.1.0",
"added"
]
]
},
"suspended": {
"description": "Boolean indicating whether the user has been suspended.",
"field_type": "bool",
"field_subtype": null,
"is_optional": true,
"is_nullable": false,
"version_history": [
[
"3.3.0",
"added"
]
],
"enum": null
},
"limited": {
"description": "Boolean indicating whether the user has been silenced.",
"field_type": "bool",
"field_subtype": null,
"is_optional": true,
"is_nullable": false,
"version_history": [
[
"3.5.3",
"added"
]
],
"enum": null
},
"bot": {
"description": "Boolean indicating whether this account is automated.",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.4.0",
"added"
]
],
"enum": null
},
"fields": {
"description": "List of up to four (by default) AccountFields",
"field_type": "EntityList",
"field_subtype": "AccountField",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.4.0",
"added"
]
],
"enum": null
},
"emojis": {
"description": "List of custom emoji used in name, bio or fields",
"field_type": "EntityList",
"field_subtype": "CustomEmoji",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.4.0",
"added"
]
],
"enum": null
},
"last_status_at": {
"description": "When the most recent status was posted.",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"3.0.0",
"added"
],
[
"3.1.0",
"now returns date only, no time"
]
],
"enum": null
},
"noindex": {
"description": "Whether the local user has opted out of being indexed by search engines.",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
},
"roles": {
"description": "Deprecated. Was a list of strings with the users roles. Now just an empty list. Mastodon.py makes no attempt to fill it, and the field may be removed if Mastodon removes it. use role field instead.",
"is_deprecated": true,
"field_type": "EntityList",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.1.0",
"added"
],
[
"4.0.0",
"deprecated"
]
]
},
"role": {
"description": "The users role. Only present for account returned from account_verify_credentials()",
"field_type": "Role",
"field_subtype": null,
"is_optional": true,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
]
},
"source": {
"description": "Additional information about the account, useful for profile editing. Only present for account returned from account_verify_credentials()",
"field_type": "AccountSource",
"field_subtype": null,
"is_optional": true,
"is_nullable": false,
"version_history": [
[
"2.4.0",
"added"
]
]
},
"mute_expires_at": {
"description": "If the user is muted by the logged in user with a timed mute, when the mute expires.",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"3.3.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Account field",
"python_name": "Field",
"func_call": "mastodon.account(<account id>).fields[0]",
"func_call_real": "mastodon.account(23972).fields[0]",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Account/",
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "A field, displayed on a users profile (e.g. \"Pronouns\", \"Favorite color\").",
"fields": {
"name": {
"description": "The key of a given field's key-value pair.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.4.0",
"added"
]
],
"enum": null
},
"value": {
"description": "The value associated with the `name` key.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.4.0",
"added"
]
],
"enum": null
},
"verified_at": {
"description": "Timestamp of when the server verified a URL value for a rel=\"me\" link.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"2.6.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Account role",
"python_name": "Role",
"func_call": "mastodon.account_verify_credentials().role",
"func_call_real": "mastodon.account_verify_credentials().role",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Role/",
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "A role granting a user a set of permissions.",
"fields": {
"id": {
"description": "The ID of the Role in the database.",
"field_type": "IdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
},
"name": {
"description": "The name of the role.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
},
"permissions": {
"description": "A bitmask that represents the sum of all permissions granted to the role.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
},
"color": {
"description": "The hex code assigned to this role. If no hex code is assigned, the string will be empty.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
},
"highlighted": {
"description": "Whether the role is publicly visible as a badge on user profiles.",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "User / account source",
"python_name": "CredentialAccountSource",
"func_call": "mastodon.account_verify_credentials()[\"source\"]",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Account/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Source values useful for editing a user's profile.",
"fields": {
"privacy": {
"description": "The user's default visibility setting (\"private\", \"unlisted\" or \"public\")",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.5.0",
"added"
]
],
"enum": {
"public": "Public post",
"unlisted": "Unlisted post",
"private": "Followers-only post",
"direct": "Direct post"
}
},
"sensitive": {
"description": "Denotes whether user media should be marked sensitive by default",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.5.0",
"added"
]
],
"enum": null
},
"note": {
"description": "Plain text version of the user's bio",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.5.0",
"added"
]
],
"enum": null
},
"language": {
"description": "The default posting language for new statuses.",
"field_type": "str",
"field_subtype": null,
"field_structuretype": "TwoLetterLanguageCodeEnum",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.4.2",
"added"
]
],
"enum": null
},
"fields": {
"description": "Metadata about the account.",
"field_type": "EntityList",
"field_subtype": "AccountField",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.4.0",
"added"
]
],
"enum": null
},
"follow_requests_count": {
"description": "The number of pending follow requests.",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Toot / Status",
"python_name": "Status",
"func_call": "mastodon.toot(\"Hello from Python\")",
"func_call_real": "mastodon.status(110446223051565765)",
"func_call_additional": "mastodon.status(110446183735368325)",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Status/",
"func_alternate_acc": false,
"manual_update": false,
"description": "A single status / toot / post",
"fields": {
"id": {
"description": "Id of this status",
"field_type": "MaybeSnowflakeIdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.1.0",
"added"
]
],
"enum": null
},
"uri": {
"description": "Descriptor for the status EG 'tag:mastodon.social,2016-11-25:objectId=<id>:objectType=Status'",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.1.0",
"added"
]
],
"enum": null
},
"url": {
"description": "URL of the status",
"field_type": "str",
"field_subtype": null,
"field_structuretype": "URL",
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"0.1.0",
"added"
]
]
},
"account": {
"description": "Account which posted the status",
"field_type": "Account",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.1.0",
"added"
]
],
"enum": null
},
"in_reply_to_id": {
"description": "Id of the status this status is in response to",
"field_type": "MaybeSnowflakeIdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"0.1.0",
"added"
]
]
},
"in_reply_to_account_id": {
"description": "Id of the account this status is in response to",
"field_type": "MaybeSnowflakeIdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"0.1.0",
"added"
]
]
},
"reblog": {
"description": "Denotes whether the status is a reblog. If so, set to the original status.",
"field_type": "Status",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"0.1.0",
"added"
]
]
},
"content": {
"description": "Content of the status, as HTML: '<p>Hello from Python</p>'",
"field_structuretype": "HTML",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.1.0",
"added"
]
],
"enum": null
},
"created_at": {
"description": "Creation time",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.1.0",
"added"
]
],
"enum": null
},
"reblogs_count": {
"description": "Number of reblogs",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.1.0",
"added"
]
]
},
"favourites_count": {
"description": "Number of favourites",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.1.0",
"added"
]
]
},
"reblogged": {
"description": "Denotes whether the logged in user has boosted this status",
"field_type": "bool",
"field_subtype": null,
"is_optional": true,
"is_nullable": false,
"version_history": [
[
"0.1.0",
"added"
]
]
},
"favourited": {
"description": "Denotes whether the logged in user has favourited this status",
"field_type": "bool",
"field_subtype": null,
"is_optional": true,
"is_nullable": false,
"version_history": [
[
"0.1.0",
"added"
]
]
},
"sensitive": {
"description": "Denotes whether media attachments to the status are marked sensitive",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.9.9",
"added"
]
],
"enum": null
},
"spoiler_text": {
"description": "Warning text that should be displayed before the status content",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.0.0",
"added"
]
],
"enum": null
},
"visibility": {
"description": "Toot visibility",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "VisibilityEnum",
"version_history": [
[
"0.9.9",
"added"
]
],
"enum": {
"public": "Publicly visible and discoverable in public timelines",
"unlisted": "Publicly visible, but not shown on public timelines and other discovery tools",
"private": "Visible only to followers",
"direct": "Visible only to people mentioned in the status",
"list": "Visible only to people on a manually curated list (pleroma-specific)",
"local": "Visible only to local followers (pleroma-specific)"
}
},
"mentions": {
"description": "A list Mentions this status includes",
"field_type": "EntityList",
"field_subtype": "Account",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
]
},
"media_attachments": {
"description": "List files attached to this status",
"field_type": "EntityList",
"field_subtype": "MediaAttachment",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
],
"enum": null
},
"emojis": {
"description": "A list of CustomEmoji used in the status",
"field_type": "EntityList",
"field_subtype": "CustomEmoji",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.0.0",
"added"
]
]
},
"tags": {
"description": "A list of Tags used in the status",
"field_type": "EntityList",
"field_subtype": "Tag",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
]
},
"bookmarked": {
"description": "True if the status is bookmarked by the logged in user, False if not.",
"field_type": "bool",
"field_subtype": null,
"is_optional": true,
"is_nullable": false,
"version_history": [
[
"3.1.0",
"added"
]
]
},
"application": {
"description": "Application for the client used to post the status (Does not federate and is therefore always None for remote statuses, can also be None for local statuses for some legacy applications registered before this field was introduced).",
"field_type": "Application",
"field_subtype": null,
"is_optional": true,
"is_nullable": false,
"version_history": [
[
"0.9.9",
"added"
]
],
"enum": null
},
"language": {
"description": "The language of the status, if specified by the server, as ISO 639-1 (two-letter) language code.",
"field_type": "str",
"field_subtype": null,
"field_structuretype": "TwoLetterLanguageCodeEnum",
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"1.4.0",
"added"
]
]
},
"muted": {
"description": "Boolean denoting whether the user has muted this status by way of conversation muting",
"field_type": "bool",
"field_subtype": null,
"is_optional": true,
"is_nullable": false,
"version_history": [
[
"1.4.0",
"added"
]
]
},
"pinned": {
"description": "Boolean denoting whether or not the status is currently pinned for the associated account.",
"field_type": "bool",
"field_subtype": null,
"is_optional": true,
"is_nullable": false,
"version_history": [
[
"1.6.0",
"added"
]
]
},
"replies_count": {
"description": "The number of replies to this status.",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.5.0",
"added"
]
]
},
"card": {
"description": "A preview card for links from the status, if present at time of delivery.",
"field_type": "PreviewCard",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"2.6.0",
"added"
]
]
},
"poll": {
"description": "A poll object if a poll is attached to this status.",
"field_type": "Poll",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"2.8.0",
"added"
]
]
},
"edited_at": {
"description": "Time the status was last edited",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"3.5.0",
"added"
]
]
},
"filtered": {
"description": "If present, a list of filter application results that indicate which of the users filters matched and what actions should be taken.",
"field_type": "EntityList",
"field_subtype": "FilterResult",
"is_optional": true,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
]
}
}
},
{
"name": "Status edit",
"python_name": "StatusEdit",
"func_call": "mastodon.status_history(<status id>)[0]",
"func_call_real": "mastodon.status_history(110446223051565765)[-1]",
"func_call_additional": "mastodon.status_history(110446183735368325)[-1]",
"masto_doc_link": "https://docs.joinmastodon.org/entities/StatusEdit/",
"func_alternate_acc": false,
"manual_update": false,
"description": "An object representing a past version of an edited status",
"fields": {
"content": {
"description": "Content for this version of the status",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
},
"spoiler_text": {
"description": "CW / Spoiler text for this version of the status",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
},
"sensitive": {
"description": "Whether media in this version of the status is marked as sensitive",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
},
"created_at": {
"description": "Time at which this version of the status was posted",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
},
"account": {
"description": "Account object of the user that posted the status",
"field_type": "Account",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
},
"media_attachments": {
"description": "List of MediaAttachment objects with the attached media for this version of the status",
"field_type": "EntityList",
"field_subtype": "MediaAttachment",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
]
},
"emojis": {
"description": "List of custom emoji used in this version of the status.",
"field_type": "EntityList",
"field_subtype": "CustomEmoji",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
]
},
"poll": {
"description": "The current state of the poll options at this revision. Note that edits changing the poll options will be collapsed together into one edit, since this action resets the poll.",
"field_type": "Poll",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Status filter action",
"python_name": "FilterResult",
"func_call": "mastodon.status(<status id>).filtered[0]",
"func_call_real": "mastodon.status(110447998920481458).filtered[0]",
"masto_doc_link": "https://docs.joinmastodon.org/entities/FilterResult/",
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "A filter action that should be taken on a status.",
"fields": {
"filter": {
"description": "The filter that was matched.",
"field_type": "V1Filter",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
},
"keyword_matches": {
"description": "The keyword within the filter that was matched.",
"field_type": "EntityList",
"field_subtype": "str",
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
},
"status_matches": {
"description": "The status ID within the filter that was matched.",
"field_type": "EntityList",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Mention",
"python_name": "StatusMention",
"func_call": "mastodon.toot(\"@admin he doing it sideways\").mentions[0]",
"func_call_real": "mastodon.status(110446223051565765).mentions[0]",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Mention/",
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "A mention of a user within a status",
"fields": {
"url": {
"description": "Mentioned user's profile URL (potentially remote)",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "URL",
"version_history": [
[
"0.6.0",
"added"
]
],
"enum": null
},
"username": {
"description": "Mentioned user's user name (not including domain)",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
],
"enum": null
},
"acct": {
"description": "Mentioned user's account name (including domain)",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
],
"enum": null
},
"id": {
"description": "Mentioned user's (local) account ID",
"field_type": "IdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Scheduled status / toot",
"python_name": "ScheduledStatus",
"func_call": "mastodon.status_post(\"futureposting\", scheduled_at=the_future)",
"func_call_real": "mastodon.status_post(\"posting in the far future\", scheduled_at=datetime(2100,12,12))",
"masto_doc_link": "https://docs.joinmastodon.org/entities/ScheduledStatus/",
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "A scheduled status / toot to be eventually posted.",
"fields": {
"id": {
"description": "Scheduled status ID (note: Not the id of the status once it gets posted!)",
"field_type": "IdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.7.0",
"added"
]
],
"enum": null
},
"scheduled_at": {
"description": "datetime object describing when the status is to be posted",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.7.0",
"added"
]
],
"enum": null
},
"params": {
"description": "Parameters for the scheduled status, specifically",
"field_type": "ScheduledStatusParams",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.7.0",
"added"
]
],
"enum": null
},
"media_attachments": {
"description": "Array of MediaAttachment objects for the attachments to the scheduled status",
"field_type": "EntityList",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.7.0",
"added"
]
]
}
}
},
{
"name": "Scheduled status / toot params",
"python_name": "ScheduledStatusParams",
"func_call": "mastodon.status_post(\"futureposting... 2\", scheduled_at=the_future).params",
"func_call_real": "mastodon.status_post(\"posting in the far future\", scheduled_at=datetime(2100,12,12)).params",
"masto_doc_link": "https://docs.joinmastodon.org/entities/ScheduledStatus/",
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Parameters for a status / toot to be posted in the future.",
"fields": {
"text": {
"description": "Toot text",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.7.0",
"added"
]
],
"enum": null
},
"in_reply_to_id": {
"description": "ID of the status this one is a reply to",
"field_type": "MaybeSnowflakeIdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"2.7.0",
"added"
]
],
"enum": null
},
"media_ids": {
"description": "IDs of media attached to this status",
"field_type": "EntityList",
"field_subtype": "str",
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"2.7.0",
"added"
]
],
"enum": null
},
"sensitive": {
"description": "Whether this status is sensitive or not",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"2.7.0",
"added"
]
],
"enum": null
},
"visibility": {
"description": "Visibility of the status",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.7.0",
"added"
]
],
"enum": null
},
"idempotency": {
"description": "Idempotency key for the scheduled status",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"2.7.0",
"added"
]
],
"enum": null
},
"scheduled_at": {
"description": "Present, but generally \"None\". Unsure what this is for - the actual scheduled_at is in the ScheduledStatus object, not here. If you know, let me know.",
"help_wanted": true,
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"2.7.0",
"added"
]
],
"enum": null
},
"spoiler_text": {
"description": "CW text for this status",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"2.7.0",
"added"
]
],
"enum": null
},
"application_id": {
"description": "ID of the application that scheduled the status",
"field_type": "IdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.7.0",
"added"
]
],
"enum": null
},
"poll": {
"description": "Poll parameters",
"field_type": "Poll",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"2.8.0",
"added"
]
],
"enum": null
},
"language": {
"description": "The language that will be used for the status.",
"field_type": "str",
"field_subtype": null,
"field_structuretype": "TwoLetterLanguageCodeEnum",
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"2.7.0",
"added"
]
],
"enum": null
},
"allowed_mentions": {
"description": "Undocumented. If you know what this does, please let me know.",
"help_wanted": true,
"field_type": "EntityList",
"field_subtype": "str",
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"2.7.0",
"added"
]
]
},
"with_rate_limit": {
"description": "Whether the status should be rate limited. It is unclear to me what this does. If you know, please let met know",
"help_wanted": true,
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.7.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Poll",
"python_name": "Poll",
"func_call": "mastodon.poll(<poll id>)",
"func_call_real": "mastodon.status(110446383900387196).poll",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Poll/",
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "A poll attached to a status",
"fields": {
"id": {
"description": "The polls ID",
"field_type": "IdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.8.0",
"added"
]
],
"enum": null
},
"expires_at": {
"description": "The time at which the poll is set to expire",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"2.8.0",
"added"
]
],
"enum": null
},
"expired": {
"description": "Boolean denoting whether users can still vote in this poll",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.8.0",
"added"
]
],
"enum": null
},
"multiple": {
"description": "Boolean indicating whether it is allowed to vote for more than one option",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.8.0",
"added"
]
],
"enum": null
},
"votes_count": {
"description": "Total number of votes cast in this poll",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.8.0",
"added"
]
],
"enum": null
},
"voted": {
"description": "Boolean indicating whether the logged-in user has already voted in this poll",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.8.0",
"added"
]
],
"enum": null
},
"options": {
"description": "The poll options",
"field_type": "EntityList",
"field_subtype": "PollOption",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.8.0",
"added"
]
],
"enum": null
},
"emojis": {
"description": "List of CustomEmoji used in answer strings,",
"field_type": "EntityList",
"field_subtype": "CustomEmoji",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.8.0",
"added"
]
],
"enum": null
},
"own_votes": {
"description": "The logged-in users votes, as a list of indices to the options.",
"field_type": "EntityList",
"field_subtype": "int",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.8.0",
"added"
]
],
"enum": null
},
"voters_count": {
"description": "How many unique accounts have voted on a multiple-choice poll.",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"2.8.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Poll option",
"python_name": "PollOption",
"func_call": "mastodon.poll(<poll id>).options[0]",
"func_call_real": "mastodon.status(110446383900387196).poll.options[0]",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Poll/",
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "A poll option within a poll",
"fields": {
"title": {
"description": "Text of the option",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.8.0",
"added"
]
],
"enum": null
},
"votes_count": {
"description": "Count of votes for the option. Can be None if the poll creator has chosen to hide vote totals until the poll expires and it hasn't yet.",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"2.8.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Conversation",
"python_name": "Conversation",
"func_call": "mastodon.conversations()[0]",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Conversation/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "A conversation (using direct / mentions-only visibility) between two or more users",
"fields": {
"id": {
"description": "The ID of this conversation object",
"field_type": "IdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.6.0",
"added"
]
],
"enum": null
},
"unread": {
"description": "Boolean indicating whether this conversation has yet to be read by the user",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.6.0",
"added"
]
],
"enum": null
},
"accounts": {
"description": "List of accounts (other than the logged-in account) that are part of this conversation",
"field_type": "EntityList",
"field_subtype": "Account",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.6.0",
"added"
]
],
"enum": null
},
"last_status": {
"description": "The newest status in this conversation",
"field_type": "Status",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"2.6.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Hashtag",
"python_name": "Tag",
"func_call": "mastodon.trending_tags()[0]",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Tag/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "A hashtag, as part of a status or on its own (e.g. trending)",
"fields": {
"name": {
"description": "Hashtag name (not including the #)",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.9.0",
"added"
]
],
"enum": null
},
"url": {
"description": "Hashtag URL (can be remote)",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "URL",
"version_history": [
[
"0.9.0",
"added"
]
],
"enum": null
},
"history": {
"description": "List of TagHistory for up to 7 days. Not present in statuses.",
"field_type": "EntityList",
"field_subtype": "TagHistory",
"is_optional": true,
"is_nullable": false,
"version_history": [
[
"2.4.1",
"added"
]
],
"enum": null
},
"following": {
"description": "Boolean indicating whether the logged-in user is following this tag.",
"field_type": "bool",
"field_subtype": null,
"is_optional": true,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
]
}
}
},
{
"name": "Hashtag usage history",
"python_name": "TagHistory",
"func_call": "mastodon.trending_tags()[0].history[0]",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Tag/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Usage history for a hashtag",
"fields": {
"day": {
"description": "Date of the day this TagHistory is for",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "datetime",
"version_history": [
[
"2.4.1",
"added"
]
],
"enum": null
},
"uses": {
"description": "Number of statuses using this hashtag on that day",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.4.1",
"added"
]
],
"enum": null
},
"accounts": {
"description": "Number of accounts using this hashtag in at least one status on that day",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.4.1",
"added"
]
],
"enum": null
}
}
},
{
"name": "Emoji",
"python_name": "CustomEmoji",
"func_call": "mastodon.toot(\":sidekiqin:\").emojis[0]",
"func_call_real": "mastodon.status(110446223051565765).emojis[0]",
"masto_doc_link": "https://docs.joinmastodon.org/entities/CustomEmoji/",
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "A custom emoji",
"fields": {
"shortcode": {
"description": "Emoji shortcode, without surrounding colons",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.0.0",
"added"
]
],
"enum": null
},
"url": {
"description": "URL for the emoji image, can be animated",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "URL",
"version_history": [
[
"2.0.0",
"added"
]
],
"enum": null
},
"static_url": {
"description": "URL for the emoji image, never animated",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "URL",
"version_history": [
[
"2.0.0",
"added"
]
],
"enum": null
},
"visible_in_picker": {
"description": "True if the emoji is enabled, False if not.",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.0.0",
"added"
]
],
"enum": null
},
"category": {
"description": "The category to display the emoji under (not present if none is set)",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Application",
"python_name": "Application",
"func_call": "mastodon.app_verify_credentials()",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Application/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Information about an app (in terms of the API)",
"fields": {
"name": {
"description": "The applications name",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.9.9",
"added"
]
],
"enum": null
},
"website": {
"description": "The applications website",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"0.9.9",
"added"
],
[
"3.5.1",
"this property is now nullable"
]
],
"enum": null
},
"vapid_key": {
"description": "A vapid key that can be used in web applications",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.8.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Relationship",
"python_name": "Relationship",
"func_call": "mastodon.account_relationships(<account id>)[0]",
"func_call_real": "mastodon.account_relationships(23972)[0]",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Relationship/",
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Information about the relationship between two users",
"fields": {
"id": {
"description": "ID of the relationship object",
"field_type": "IdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
],
"enum": null
},
"following": {
"description": "Boolean denoting whether the logged-in user follows the specified user",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
],
"enum": null
},
"followed_by": {
"description": "Boolean denoting whether the specified user follows the logged-in user",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
],
"enum": null
},
"blocking": {
"description": "Boolean denoting whether the logged-in user has blocked the specified user",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
],
"enum": null
},
"blocked_by": {
"description": "Boolean denoting whether the logged-in user has been blocked by the specified user, if information is available",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.8.0",
"added"
]
],
"enum": null
},
"muting": {
"description": "Boolean denoting whether the logged-in user has muted the specified user",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.1.0",
"added"
]
],
"enum": null
},
"muting_notifications": {
"description": "Boolean denoting wheter the logged-in user has muted notifications related to the specified user",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.1.0",
"added"
]
],
"enum": null
},
"requested": {
"description": "Boolean denoting whether the logged-in user has sent the specified user a follow request",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.9.9",
"added"
]
],
"enum": null
},
"domain_blocking": {
"description": "Boolean denoting whether the logged-in user has blocked the specified users domain",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.4.0",
"added"
]
],
"enum": null
},
"showing_reblogs": {
"description": "Boolean denoting whether the specified users reblogs show up on the logged-in users Timeline",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.1.0",
"added"
]
],
"enum": null
},
"endorsed": {
"description": "Boolean denoting wheter the specified user is being endorsed / featured by the logged-in user",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.5.0",
"added"
]
],
"enum": null
},
"note": {
"description": "A free text note the logged in user has created for this account (not publicly visible)",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.2.0",
"added"
]
],
"enum": null
},
"notifying": {
"description": "Boolean indicating whether the logged-in user has enabled notifications for this users posts",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.3.0",
"added"
]
],
"enum": null
},
"languages": {
"description": "List of languages that the logged in user is following this user for (if any)",
"field_type": "EntityList",
"field_subtype": "str",
"field_structuretype": "TwoLetterLanguageCodeEnum",
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
},
"requested_by": {
"description": "Boolean indicating whether the specified user has sent the logged-in user a follow request",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.9.9",
"added"
]
]
}
}
},
{
"name": "Filter",
"python_name": "Filter",
"func_call": "mastodon.filters()[0]",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Filter/",
"masto_doc_link_additional": "https://docs.joinmastodon.org/entities/V1_Filter/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"has_versions": [
"v1",
"v2"
],
"description": "Information about a keyword / status filter",
"fields": {
"id": {
"description": "Id of the filter",
"field_type": "IdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.4.3",
"added"
]
],
"enum": null
},
"phrase": {
"description": "Filtered keyword or phrase",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"api_version": "v1",
"version_history": [
[
"2.4.3",
"added"
],
[
"4.0.0",
"removed (still present in v1 API variant)"
]
],
"enum": null
},
"context": {
"description": "List of places where the filters are applied.",
"field_type": "EntityList",
"field_subtype": "str",
"is_optional": false,
"is_nullable": false,
"field_structuretype": "FilterContextEnum",
"version_history": [
[
"2.4.3",
"added"
],
[
"3.1.0",
"added `account`"
]
],
"enum": {
"home": "Home timeline and lists",
"notifications": "Notifications timeline",
"public": "Puclic timelines",
"thread": "Expanded view of a status with replies",
"account": "Posts displayed when viewing a profile"
}
},
"expires_at": {
"description": "Expiry date for the filter",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"2.4.3",
"added"
]
],
"enum": null
},
"irreversible": {
"description": "Boolean denoting if this filter is executed server-side or if it should be ran client-side.",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"api_version": "v1",
"version_history": [
[
"2.4.3",
"added"
],
[
"4.0.0",
"removed (still present in v1 API variant)"
]
],
"enum": null
},
"whole_word": {
"description": "Boolean denoting whether this filter can match partial words",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"api_version": "v1",
"version_history": [
[
"2.4.3",
"added"
],
[
"4.0.0",
"removed (still present in v1 API variant)"
]
],
"enum": null
},
"title": {
"description": "Name the user has chosen for this filter",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"api_version": "v2",
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
},
"filter_action": {
"description": "The action to be taken when a status matches this filter.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "FilterActionEnum",
"api_version": "v2",
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": {
"warn": "Display a note to the user that the status has been filtered, showing the title of the filter. The mastodon documentation suggests that absent any other information or if unknown values are encountered, this should be the default action to take.",
"hide": "Hide the status from the user completely, as if it did not exist"
}
},
"keywords": {
"description": "A list of keywords that will trigger this filter.",
"field_type": "EntityList",
"field_subtype": "FilterKeyword",
"is_optional": false,
"is_nullable": false,
"api_version": "v2",
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
},
"statuses": {
"description": "A list of statuses that will trigger this filter.",
"field_type": "EntityList",
"field_subtype": "FilterStatus",
"is_optional": false,
"is_nullable": false,
"api_version": "v2",
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Notification",
"python_name": "Notification",
"func_call": "mastodon.notifications()[0]",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Notification/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "A notification about some event, like a new reply or follower.",
"fields": {
"id": {
"description": "id of the notification",
"field_type": "IdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.9.9",
"added"
]
],
"enum": null
},
"type": {
"description": "\"mention\", \"reblog\", \"favourite\", \"follow\", \"poll\" or \"follow_request\"",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "NotificationTypeEnum",
"version_history": [
[
"0.9.9",
"added"
],
[
"2.8.0",
"added `poll`"
],
[
"3.1.0",
"added `follow_request`"
],
[
"3.3.0",
"added `status`"
],
[
"3.5.0",
"added `update` and `admin.sign_up`"
],
[
"4.0.0",
"added `admin.report`"
]
],
"enum": null
},
"created_at": {
"description": "The time the notification was created",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.9.9",
"added"
]
],
"enum": null
},
"account": {
"description": "Account of the user from whom the notification originates",
"field_type": "Account",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.9.9",
"added"
]
],
"enum": null
},
"status": {
"description": "In case of \"mention\", the mentioning status In case of reblog / favourite, the reblogged / favourited status",
"field_type": "Status",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.9.9",
"added"
]
],
"enum": null
}
}
},
{
"name": "Context",
"python_name": "Context",
"func_call": "mastodon.status_context(<status id>)",
"func_call_real": "mastodon.status_context(110446983926957470)",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Context/",
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "The conversation context for a given status, i.e. its predecessors (that it replies to) and successors (that reply to it).",
"fields": {
"ancestors": {
"description": "A list of Statuses that the Status with this Context is a reply to",
"field_type": "EntityList",
"field_subtype": "Status",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
],
"enum": null
},
"descendants": {
"description": "A list of Statuses that are replies to the Status with this Context",
"field_type": "EntityList",
"field_subtype": "Status",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "User List",
"python_name": "UserList",
"func_call": "mastodon.lists()[0]",
"masto_doc_link": "https://docs.joinmastodon.org/entities/List/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "A list of users",
"fields": {
"id": {
"description": "id of the list",
"field_type": "IdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.1.0",
"added"
]
],
"enum": null
},
"title": {
"description": "title of the list",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.1.0",
"added"
]
],
"enum": null
},
"replies_policy": {
"description": "Which replies should be shown in the list.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "RepliesPolicyEnum",
"version_history": [
[
"3.3.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Media attachment",
"python_name": "MediaAttachment",
"func_call": "mastodon.media_post(\"image.jpg\", \"image/jpeg\")[\"meta\"]",
"func_call_real": "mastodon.status(110447012773105565).media_attachments[0]",
"func_call_additional": "mastodon.status(110447003454258227).media_attachments[0]",
"masto_doc_link": "https://docs.joinmastodon.org/entities/MediaAttachment/",
"func_alternate_acc": false,
"manual_update": false,
"description": "A piece of media (like an image, video, or audio file) that can be or has been attached to a status.",
"fields": {
"id": {
"description": "The ID of the attachment.",
"field_type": "MaybeSnowflakeIdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
],
"enum": null
},
"type": {
"description": "Media type: 'image', 'video', 'gifv', 'audio' or 'unknown'.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
],
[
"2.9.1",
"added `audio`"
]
],
"enum": {
"unknown": "unsupported or unrecognized file type",
"image": "Static image",
"gifv": "Looping, soundless animation",
"video": "Video clip",
"audio": "Audio track"
}
},
"url": {
"description": "The URL for the image in the local cache",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "URL",
"version_history": [
[
"0.6.0",
"added"
]
],
"enum": null
},
"remote_url": {
"description": "The remote URL for the media (if the image is from a remote instance)",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"field_structuretype": "URL",
"version_history": [
[
"0.6.0",
"added"
]
],
"enum": null
},
"preview_url": {
"description": "The URL for the media preview",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "URL",
"version_history": [
[
"0.6.0",
"added"
]
],
"enum": null
},
"text_url": {
"description": "Deprecated. The display text for the media (what shows up in text). May not be present in mastodon versions after 3.5.0",
"deprecated": true,
"field_type": "str",
"field_subtype": null,
"field_structuretype": "URL",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
],
[
"3.5.0",
"removed"
]
]
},
"meta": {
"description": "MediaAttachmentMetadataContainer that contains metadata for 'original' and 'small' (preview) versions of the MediaAttachment. Either may be empty. May additionally contain an \"fps\" field giving a videos frames per second (possibly rounded), and a \"length\" field giving a videos length in a human-readable format. Note that a video may have an image as preview. May also contain a 'focus' object and a media 'colors' object.",
"field_type": "MediaAttachmentMetadataContainer",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.5.0",
"added"
],
[
"2.3.0",
"added focus"
],
[
"4.0.0",
"added colors"
]
],
"enum": null
},
"blurhash": {
"description": "The blurhash for the image, used for preview / placeholder generation",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "Blurhash",
"version_history": [
[
"2.8.1",
"added"
]
],
"enum": null
},
"description": {
"description": "If set, the user-provided description for this media.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"2.0.0",
"added"
]
],
"enum": null
},
"preview_remote_url": {
"description": "If set, the remote URL for the thumbnail of this media attachment on the or originating instance.",
"field_type": "str",
"field_subtype": null,
"field_structuretype": "URL",
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"0.6.0",
"added"
]
]
}
}
},
{
"name": "Media metadata container",
"func_call_real": "mastodon.status(110447012773105565).media_attachments[0].meta",
"func_call_additional": "mastodon.status(110447003454258227).media_attachments[0].meta",
"python_name": "MediaAttachmentMetadataContainer",
"func_call": "mastodon.media_post(\"audio.mp3\").meta",
"masto_doc_link": "https://docs.joinmastodon.org/entities/MediaAttachment/",
"func_alternate_acc": false,
"manual_update": false,
"description": "An object holding metadata about a media attachment and its thumbnail.",
"fields": {
"original": {
"description": "Metadata for the original media attachment",
"field_type": "Union[MediaAttachmentImageMetadata, MediaAttachmentVideoMetadata, MediaAttachmentAudioMetadata]",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
]
},
"small": {
"description": "Metadata for the thumbnail of this media attachment.",
"field_type": "MediaAttachmentImageMetadata",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
]
},
"colors": {
"description": "Information about accent colors for the media.",
"field_type": "MediaAttachmentColors",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
]
},
"focus": {
"description": "Information about the focus point for the media.",
"field_type": "MediaAttachmentFocusPoint",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.3.0",
"added"
]
]
}
}
},
{
"name": "Media image metadata",
"python_name": "MediaAttachmentImageMetadata",
"func_call": "mastodon.media_post(\"image.jpg\").meta.original",
"func_call_real": "mastodon.status(110447003454258227).media_attachments[0].meta.original",
"masto_doc_link": "https://docs.joinmastodon.org/entities/MediaAttachment/",
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Metadata for an image media attachment.",
"fields": {
"width": {
"description": "Width of the image in pixels",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
]
},
"height": {
"description": "Height of the image in pixels",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
]
},
"aspect": {
"description": "Aspect ratio of the image as a floating point number",
"field_type": "float",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
]
},
"size": {
"description": "Textual representation of the image size in pixels, e.g. '800x600'",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
]
}
}
},
{
"name": "Media video and gifv metadata",
"python_name": "MediaAttachmentVideoMetadata",
"func_call": "mastodon.media_post(\"video.mp4\").meta.original",
"func_call_real": "mastodon.status(110447001287656894).media_attachments[0].meta.original",
"func_call_additional": "mastodon.status(110447018236380496).media_attachments[0].meta.original",
"masto_doc_link": "https://docs.joinmastodon.org/entities/MediaAttachment/",
"func_alternate_acc": false,
"manual_update": false,
"description": "Metadata for a video or gifv media attachment.",
"fields": {
"width": {
"description": "Width of the video in pixels",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
]
},
"height": {
"description": "Height of the video in pixels",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
]
},
"frame_rate": {
"description": "Exact frame rate of the video in frames per second. Can be an integer fraction (i.e. \"20/7\")",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
]
},
"duration": {
"description": "Duration of the video in seconds",
"field_type": "float",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
]
},
"bitrate": {
"description": "Average bit-rate of the video in bytes per second",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
]
}
}
},
{
"name": "Media audio metadata",
"python_name": "MediaAttachmentAudioMetadata",
"func_call": "mastodon.media_post(\"audio.mp3\").meta.original",
"func_call_real": "mastodon.status(110447012773105565).media_attachments[0].meta.original",
"masto_doc_link": "https://docs.joinmastodon.org/entities/MediaAttachment/",
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Metadata for an audio media attachment.",
"fields": {
"duration": {
"description": "Duration of the audio file in seconds",
"field_type": "float",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
]
},
"bitrate": {
"description": "Average bit-rate of the audio file in bytes per second",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"0.6.0",
"added"
]
]
}
}
},
{
"name": "Media focus point",
"python_name": "MediaAttachmentFocusPoint",
"func_call": "mastodon.media_post(\"image.jpg\").meta.focus",
"func_call_real": "mastodon.status(110447003454258227).media_attachments[0].meta.focus",
"masto_doc_link": "https://docs.joinmastodon.org/entities/MediaAttachment/",
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "The focus point for a media attachment, for cropping purposes.",
"fields": {
"x": {
"description": "Focus point x coordinate (between -1 and 1), with 0 being the center and -1 and 1 being the left and right edges respectively.",
"field_type": "float",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.3.0",
"added"
]
]
},
"y": {
"description": "Focus point x coordinate (between -1 and 1), with 0 being the center and -1 and 1 being the upper and lower edges respectively.",
"field_type": "float",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.3.0",
"added"
]
]
}
}
},
{
"name": "Media colors",
"python_name": "MediaAttachmentColors",
"func_call": "mastodon.media_post(\"image.jpg\").meta.colors",
"func_call_real": "mastodon.status(110447012773105565).media_attachments[0].meta.colors",
"masto_doc_link": "https://docs.joinmastodon.org/entities/MediaAttachment/",
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Object describing the accent colors for a media attachment.",
"fields": {
"foreground": {
"description": "Estimated foreground colour for the attachment thumbnail, as a html format hex color (#rrggbb)",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
]
},
"background": {
"description": "Estimated background colour for the attachment thumbnail, as a html format hex color (#rrggbb)",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
]
},
"accent": {
"description": "Estimated accent colour for the attachment thumbnail",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
]
}
}
},
{
"name": "Card",
"func_call": "mastodon.status_card(<status id>)",
"func_call_real": "mastodon.status_card(110447098625216345)",
"python_name": "PreviewCard",
"masto_doc_link": "https://docs.joinmastodon.org/entities/PreviewCard/",
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "A preview card attached to a status, e.g. for an embedded video or link.",
"fields": {
"url": {
"description": "The URL of the card.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "URL",
"version_history": [
[
"1.0.0",
"added"
]
],
"enum": null
},
"title": {
"description": "The title of the card.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.0.0",
"added"
]
],
"enum": null
},
"description": {
"description": "Description of the embedded content",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.0.0",
"added"
]
],
"enum": null
},
"type": {
"description": "Embed type: 'link', 'photo', 'video', or 'rich'",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.3.0",
"added"
]
],
"enum": {
"link": "Link OEmbed",
"photo": "Photo OEmbed",
"video": "Video OEmbed",
"rich": "iframe OEmbed. Not currently accepted, so won't show up in practice."
}
},
"image": {
"description": "(optional) The image associated with the card.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"field_structuretype": "URL",
"version_history": [
[
"1.0.0",
"added"
]
],
"enum": null
},
"author_name": {
"description": "Name of the embedded contents author",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.3.0",
"added"
]
],
"enum": null
},
"author_url": {
"description": "URL pointing to the embedded contents author",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "URL",
"version_history": [
[
"1.3.0",
"added"
]
],
"enum": null
},
"width": {
"description": "Width of the embedded object",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.3.0",
"added"
]
],
"enum": null
},
"height": {
"description": "Height of the embedded object",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.3.0",
"added"
]
],
"enum": null
},
"html": {
"description": "HTML string representing the embed",
"field_type": "str",
"field_subtype": null,
"field_structuretype": "HTML",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.3.0",
"added"
]
],
"enum": null
},
"provider_name": {
"description": "Name of the provider from which the embed originates",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.3.0",
"added"
]
],
"enum": null
},
"provider_url": {
"description": "URL pointing to the embeds provider",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "URL",
"version_history": [
[
"1.3.0",
"added"
]
],
"enum": null
},
"blurhash": {
"description": "Blurhash of the preview image",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"field_structuretype": "Blurhash",
"version_history": [
[
"3.2.0",
"added"
]
],
"enum": null
},
"language": {
"description": "Language of the embedded content",
"field_type": "str",
"field_subtype": null,
"field_structuretype": "TwoLetterLanguageCodeEnum",
"is_optional": true,
"is_nullable": false,
"version_history": [
[
"1.3.0",
"added"
]
]
},
"embed_url": {
"description": "Used for photo embeds, instead of custom `html`.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "URL",
"version_history": [
[
"2.1.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Search result",
"python_name": "Search",
"func_call": "mastodon.search(\"<search query>\")",
"func_call_real": "mastodon.search(\"halcy\")",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Search/",
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "A search result, with accounts, hashtags and statuses.",
"fields": {
"accounts": {
"description": "List of Accounts resulting from the query",
"field_type": "EntityList",
"field_subtype": "Account",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.1.0",
"added"
]
],
"enum": null
},
"hashtags": {
"description": "List of Tags resulting from the query",
"field_type": "EntityList",
"field_subtype": "Union[str, Tag]",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.1.0",
"added"
],
[
"2.4.1",
"v1 search deprecated because it returns a list of strings. v2 search added which returns a list of tags."
],
[
"3.0.0",
"v1 removed"
]
],
"enum": null
},
"statuses": {
"description": "List of Statuses resulting from the query",
"field_type": "EntityList",
"field_subtype": "Status",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.1.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Instance",
"python_name": "Instance",
"func_call": "mastodon.instance()",
"func_call_additional": "mastodon.instance_v1()",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Instance/",
"masto_doc_link_additional": "https://docs.joinmastodon.org/entities/V1_Instance/",
"func_call_real": null,
"func_alternate_acc": false,
"manual_update": false,
"has_versions": [
"v1",
"v2"
],
"description": "Information about an instance",
"fields": {
"domain": {
"description": "The instances domain name",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "DomainName",
"api_version": "v2",
"version_history": [
[
"4.0.0",
"added"
]
]
},
"description": {
"description": "A brief instance description set by the admin. The V1 variant could contain html, but this is now deprecated.",
"field_type": "str",
"field_subtype": null,
"field_structuretype": "HTML",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.1.0",
"added"
],
[
"4.0.0",
"now contains what was previously short_description, no HTML allowed anymore"
]
],
"enum": null
},
"short_description": {
"description": "An even briefer instance description. Moved to just 'description' for the v2 API, though Mastodon.py will mirror it here for backwards compatibility.",
"moved_path": "description",
"deprecated": true,
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.9.2",
"added"
],
[
"4.0.0",
"removed"
]
],
"enum": null
},
"email": {
"description": "The admin contact email. Moved to InstanceContacts for the v2 API, though Mastodon.py will mirror it here for backwards compatibility.",
"moved_path": "contact.email",
"deprecated": true,
"field_type": "str",
"field_subtype": null,
"field_structuretype": "Email",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.1.0",
"added"
],
[
"4.0.0",
"removed"
]
],
"enum": null
},
"title": {
"description": "The instance's title",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.1.0",
"added"
]
],
"enum": null
},
"uri": {
"description": "The instance's domain name. Moved to 'domain' for the v2 API, though Mastodon.py will mirror it here for backwards compatibility.",
"field_type": "str",
"deprecated:": true,
"moved_path": "domain",
"field_structuretype": "DomainName",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.1.0",
"added"
]
],
"enum": null
},
"version": {
"description": "The instance's Mastodon version",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.3.0",
"added"
]
],
"enum": null
},
"urls": {
"description": "Additional InstanceURLs, at least 'streaming_api' with the stream server websocket address. Moved to the instance configuration for the v2 API, though Mastodon.py will mirror it here for backwards compatibility.",
"field_type": "InstanceURLs",
"moved_path": "configuration.urls",
"deprecated": true,
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.4.2",
"added"
],
[
"4.0.0",
"removed"
]
],
"enum": null
},
"stats": {
"description": "InstanceStatistics containing three stats, user_count (number of local users), status_count (number of local statuses) and domain_count (number of known instance domains other than this one). Removed in the v2 API, if you want this, explicitly call instance_v1() instead, or check out instance_nodeinfo().",
"field_type": "InstanceStatistics",
"field_subtype": null,
"is_optional": true,
"is_nullable": false,
"api_version": "v1",
"version_history": [
[
"1.6.0",
"added"
],
[
"4.0.0",
"removed (still present in instance_v1())"
]
]
},
"usage": {
"description": "Information about recent activity on this instance.",
"field_type": "InstanceUsage",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
]
},
"contact_account": {
"description": "Account of the primary contact for the instance. Moved to InstanceContacts for the v2 API, though Mastodon.py will mirror it here for backwards compatibility.",
"moved_path": "contact.account",
"deprecated": true,
"field_type": "Account",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.1.0",
"added"
],
[
"4.0.0",
"removed"
]
]
},
"languages": {
"description": "Array of ISO 639-1 (two-letter) language codes the instance has chosen to advertise.",
"field_type": "EntityList",
"field_subtype": "str",
"field_structuretype": "TwoLetterLanguageCodeEnum",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.3.0",
"added"
]
]
},
"registrations": {
"description": "InstanceRegistrations object with information about how users can sign up on this instance. In the v1 version, a boolean indication whether registrations on this instance are open (True) or not (False). If you want this behaviour, explicitly use instance_v1().",
"field_type": "Union[InstanceRegistrations, bool]",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.6.0",
"added"
],
[
"4.0.0",
"changed to be an InststanceRegistrations object instead of a bool"
]
]
},
"approval_required": {
"description": "True if account approval is required when registering, False if not. Moved to InstanceRegistrations object for the v2 API, though Mastodon.py will mirror it here for backwards compatibility.",
"moved_path": "registrations.approval_required",
"field_type": "bool",
"deprecated": true,
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.9.2",
"added"
],
[
"4.0.0",
"removed"
]
]
},
"rules": {
"description": "List of Rules with `id` and `text` fields, one for each server rule set by the admin",
"field_type": "EntityList",
"field_subtype": "Rule",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.4.0",
"added"
]
]
},
"source_url": {
"description": "URL pointing to a copy of the source code that is used to run this instance. For Mastodon instances, the AGPL requires that this code be available.",
"field_type": "Union[InstanceThumbnail, str]",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "URL",
"version_history": [
[
"3.4.0",
"added"
]
]
},
"thumbnail": {
"description": "Information about thumbnails to represent the instance. In the v1 API variant, simply an URL pointing to a banner image representing the instance - if you want this behaviour, explicitly call instance_v1().",
"field_type": "str",
"field_subtype": null,
"field_structuretype": "URL",
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"1.6.1",
"added"
]
]
},
"invites_enabled": {
"description": "Boolean indicating whether invites are enabled on this instance. Changed in 4.0.0 from being true when the instance setting to enable invites is true to be true when the default user role has invites enabled (i.e. everyone can invite people). Removed for the v2 API, if you need this field, explicitly use instance_v1() instead.",
"deprecated": true,
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"api_version": "v1",
"version_history": [
[
"3.1.4",
"added"
],
[
"4.0.0",
"removed (still present in instance_v1()). Changed specifics of when field is true."
]
]
},
"configuration": {
"description": "Various instance configuration settings - especially various limits (character counts, media upload sizes, ...)",
"field_type": "InstanceConfiguration",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.1.4",
"added"
]
]
}
}
},
{
"name": "Instance thumbnail",
"python_name": "InstanceThumbnail",
"func_call": "mastodon.instance().thumbnail",
"masto_doc_link": "https://docs.joinmastodon.org/entities/V1_Instance/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Extended information about an instances thumbnail.",
"fields": {
"url": {
"description": "The URL for an image representing the instance.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "URL",
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
},
"blurhash": {
"description": "The blurhash for the image representing the instance.",
"field_type": "str",
"field_subtype": null,
"is_optional": true,
"is_nullable": false,
"field_structuretype": "Blurhash",
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
},
"versions": {
"description": "Different resolution versions of the image representing the instance.",
"field_type": "InstanceThumbnailVersions",
"field_subtype": null,
"is_optional": true,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Instance thumbnail versions",
"python_name": "InstanceThumbnailVersions",
"func_call": "mastodon.instance().thumbnail.versions",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Instance/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Different resolution versions of the image representing the instance.",
"fields": {
"@1x": {
"description": "The URL for an image representing the instance, for devices with 1x resolution / 96 dpi",
"python_name": "at1x",
"field_type": "str",
"field_subtype": null,
"is_optional": true,
"is_nullable": false,
"field_structuretype": "URL",
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
},
"@2x": {
"description": "The URL for the image representing the instance, for devices with 2x resolution / 192 dpi",
"field_type": "str",
"python_name": "at2x",
"field_subtype": null,
"is_optional": true,
"is_nullable": false,
"field_structuretype": "URL",
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Instance urls",
"python_name": "InstanceURLs",
"func_call": "mastodon.instance().configuration.urls",
"func_call_additional": "mastodon.instance_v1().urls",
"masto_doc_link": "https://docs.joinmastodon.org/entities/V1_Instance/",
"func_call_real": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "A list of URLs related to an instance.",
"fields": {
"streaming": {
"description": "The Websockets URL for connecting to the streaming API. Was 'streaming_api' in v1",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "URL",
"version_history": [
[
"1.4.2",
"added"
]
],
"enum": null
},
"streaming_api": {
"description": "The Websockets URL for connecting to the streaming API. Only present in v1, though Mastodon.py will mirror the appropriate value from 'streaming' for the v2 API.",
"field_type": "str",
"moved_path": "streaming",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"is_deprecated": true,
"field_structuretype": "URL",
"version_history": [
[
"3.4.2",
"added"
],
[
"4.0.0",
"deprecated"
]
],
"enum": null
},
"status": {
"description": "If present, a URL where the status and possibly current issues with the instance can be checked.",
"field_type": "str",
"field_subtype": null,
"is_optional": true,
"is_nullable": false,
"field_structuretype": "URL",
"version_history": [
[
"4.0.0",
"added"
]
]
}
}
},
{
"name": "Instance statistics",
"python_name": "InstanceStatistics",
"func_call": "mastodon.instance_v1().stats",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Instance/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Usage statistics for an instance.",
"fields": {
"user_count": {
"description": "The total number of accounts that have been created on this instance.",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.6.0",
"added"
]
]
},
"status_count": {
"description": "The total number of local posts that have been made on this instance.",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.6.0",
"added"
]
]
},
"domain_count": {
"description": "The total number of other instances that this instance is aware of.",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"1.6.0",
"added"
]
]
}
}
},
{
"name": "Instance usage",
"python_name": "InstanceUsage",
"func_call": "mastodon.instance().usage",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Instance/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Usage / recent activity information for this instance.",
"fields": {
"users": {
"description": "Information about user counts on this instance.",
"field_type": "InstanceUsageUsers",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
]
}
}
},
{
"name": "Instance usage user information",
"python_name": "InstanceUsageUsers",
"func_call": "mastodon.instance().usage.users",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Instance/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Recent active user information about this instance.",
"fields": {
"active_month": {
"description": "This instances most recent monthly active user count.",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
]
}
}
},
{
"name": "Instance rule",
"python_name": "Rule",
"func_call": "mastodon.instance().rules[0]",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Rule/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "A rule that instance staff has specified users must follow on this instance.",
"fields": {
"id": {
"description": "An identifier for the rule.",
"field_type": "IdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.4.0",
"added"
]
],
"enum": null
},
"text": {
"description": "The rule to be followed.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.4.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Instance registration information",
"python_name": "InstanceRegistrations",
"func_call": "mastodon.instance().registrations",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Instance/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Registration information for this instance, like whether registrations are open and whether they require approval.",
"fields": {
"approval_required": {
"description": "Boolean indicating whether registrations on the instance require approval.",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
]
},
"enabled": {
"description": "Boolean indicating whether registrations are enabled on this instance.",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
]
},
"message": {
"description": "A message to be shown instead of the sign-up form when registrations are closed.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"field_structuretype": "HTML",
"version_history": [
[
"4.0.0",
"added"
]
]
}
}
},
{
"name": "Instance contact information",
"python_name": "InstanceContacts",
"func_call": "mastodon.instance().contact",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Instance/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Contact information for this instances' staff.",
"fields": {
"account": {
"description": "Account that has been designated as the instances contact account.",
"field_type": "Account",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
]
},
"email": {
"description": "E-mail address that can be used to contact the instance staff.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "Email",
"version_history": [
[
"4.0.0",
"added"
]
]
}
}
},
{
"name": "Instance configuration",
"python_name": "InstanceConfiguration",
"func_call": "mastodon.instance().configuration",
"masto_doc_link": "https://docs.joinmastodon.org/methods/instance/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"api_versions": [
"v1",
"v2"
],
"description": "Configuration values for this instance, especially limits and enabled features.",
"fields": {
"accounts": {
"description": "Account-related instance configuration fields",
"field_type": "InstanceAccountConfiguration",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
]
},
"statuses": {
"description": "Status-related instance configuration fields",
"field_type": "InstanceStatusConfiguration",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.4.2",
"added"
]
]
},
"media_attachments": {
"description": "Media-related instance configuration fields",
"field_type": "InstanceMediaConfiguration",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.4.2",
"added"
]
]
},
"polls": {
"description": "Poll-related instance configuration fields",
"field_type": "InstancePollConfiguration",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.4.2",
"added"
]
]
},
"translation": {
"description": "Translation-related instance configuration fields. Only present for the v2 API variant of the instance API.",
"field_type": "InstanceTranslationConfiguration",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"api_version": "v2",
"version_history": [
[
"4.0.0",
"added"
]
]
},
"urls": {
"description": "Instance related URLs. Only present for the v2 API variant of the instance API.",
"field_type": "InstanceURLs",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"api_version": "v2",
"version_history": [
[
"4.0.0",
"added"
]
]
}
}
},
{
"name": "Instance account configuration",
"python_name": "InstanceAccountConfiguration",
"func_call": "mastodon.instance().configuration.accounts",
"masto_doc_link": "https://docs.joinmastodon.org/methods/instance/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Configuration values relating to accounts.",
"fields": {
"max_featured_tags": {
"description": "The maximum number of featured tags that can be displayed on a profile.",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
]
}
}
},
{
"name": "Instance status configuration",
"python_name": "InstanceStatusConfiguration",
"func_call": "mastodon.instance().configuration.statuses",
"masto_doc_link": "https://docs.joinmastodon.org/methods/instance/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Configuration values relating to statuses.",
"fields": {
"max_characters": {
"description": "Maximum number of characters in a status this instance allows local users to use.",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.4.2",
"added"
]
]
},
"max_media_attachments": {
"description": "Maximum number of media attachments per status this instance allows local users to use.",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.4.2",
"added"
]
]
},
"characters_reserved_per_url": {
"description": "Number of characters that this instance counts a URL as when counting charaters.",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.4.2",
"added"
]
]
}
}
},
{
"name": "Instance translation configuration",
"python_name": "InstanceTranslationConfiguration",
"func_call": "mastodon.instance().configuration.translation",
"masto_doc_link": "https://docs.joinmastodon.org/methods/instance/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Configuration values relating to translation.",
"fields": {
"enabled": {
"description": "Boolean indicating whether the translation API is enabled on this instance.",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
]
}
}
},
{
"name": "Instance media attachment configuration",
"python_name": "InstanceMediaConfiguration",
"func_call": "mastodon.instance().configuration.media_attachments",
"masto_doc_link": "https://docs.joinmastodon.org/methods/instance/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Configuration values relating to media attachments.",
"fields": {
"supported_mime_types": {
"description": "Mime types the instance accepts for media attachment uploads.",
"field_type": "EntityList",
"field_subtype": "str",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.4.2",
"added"
]
]
},
"image_size_limit": {
"description": "Maximum size (in bytes) the instance will accept for image uploads.",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.4.2",
"added"
]
]
},
"image_matrix_limit": {
"description": "Maximum total number of pixels (i.e. width * height) the instance will accept for image uploads.",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.4.2",
"added"
]
]
},
"video_size_limit": {
"description": "Maximum size (in bytes) the instance will accept for video uploads",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.4.2",
"added"
]
]
},
"video_frame_rate_limit": {
"description": "Maximum frame rate the instance will accept for video uploads",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.4.2",
"added"
]
]
},
"video_matrix_limit": {
"description": "Maximum total number of pixels (i.e. width * height) the instance will accept for video uploads",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.4.2",
"added"
]
]
}
}
},
{
"name": "Instance poll configuration",
"python_name": "InstancePollConfiguration",
"func_call": "mastodon.instance().configuration.polls",
"masto_doc_link": "https://docs.joinmastodon.org/methods/instance/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Configuration values relating to polls.",
"fields": {
"max_options": {
"description": "How many poll options this instance allows local users to use per poll",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.4.2",
"added"
]
]
},
"max_characters_per_option": {
"description": "Maximum number of characters this instance allows local users to use per poll option",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.4.2",
"added"
]
]
},
"min_expiration": {
"description": "The shortest allowed duration for a poll on this instance, in seconds",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.4.2",
"added"
]
]
},
"max_expiration": {
"description": "The longest allowed duration for a poll on this instance, in seconds",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.4.2",
"added"
]
]
}
}
},
{
"name": "Nodeinfo",
"python_name": "Nodeinfo",
"func_call": "mastodon.instance_nodeinfo()",
"masto_doc_link": "https://github.com/jhass/nodeinfo",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "The instances standardized NodeInfo data.",
"fields": {
"version": {
"description": "Version of the nodeinfo schema spec that was used for this response.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
]
},
"software": {
"description": "Information about the server software being used on this instance.",
"field_type": "NodeinfoSoftware",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
]
},
"protocols": {
"description": "A list of strings specifying the federation protocols this instance supports. Typically, just \"activitypub\".",
"field_type": "EntityList",
"field_subtype": "str",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
]
},
"services": {
"description": "Services that this instance can retrieve messages from or send messages to.",
"field_type": "NodeinfoServices",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
]
},
"usage": {
"description": "Information about recent activity on this instance.",
"field_type": "NodeinfoUsage",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
]
},
"openRegistrations": {
"description": "Bool indicating whether the instance is open for registrations.",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
]
},
"metadata": {
"description": "Additional node metadata. On Mastodon, typically an empty object with no fields.",
"field_type": "NodeinfoMetadata",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
]
}
}
},
{
"name": "Nodeinfo software",
"python_name": "NodeinfoSoftware",
"func_call": "mastodon.instance_nodeinfo().software",
"masto_doc_link": "https://github.com/jhass/nodeinfo",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "NodeInfo software-related information.",
"fields": {
"name": {
"description": "Name of the software used by this instance.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
]
},
"version": {
"description": "String indicating the version of the software used by this instance.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
]
}
}
},
{
"name": "Nodeinfo services",
"python_name": "NodeinfoServices",
"func_call": "mastodon.instance_nodeinfo().services",
"masto_doc_link": "https://github.com/jhass/nodeinfo",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Nodeinfo services-related information.",
"fields": {
"outbound": {
"description": "List of services that this instance can send messages to. On Mastodon, typically an empty list.",
"field_type": "EntityList",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
]
},
"inbound": {
"description": "List of services that this instance can retrieve messages from. On Mastodon, typically an empty list.",
"field_type": "EntityList",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
]
}
}
},
{
"name": "Nodeinfo usage",
"python_name": "NodeinfoUsage",
"func_call": "mastodon.instance_nodeinfo().usage",
"masto_doc_link": "https://github.com/jhass/nodeinfo",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Nodeinfo usage-related information.",
"fields": {
"users": {
"description": "Information about user counts on this instance.",
"field_type": "NodeinfoUsageUsers",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
]
},
"localPosts": {
"description": "The total number of local posts that have been made on this instance.",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
]
}
}
},
{
"name": "Nodeinfo usage user count",
"python_name": "NodeinfoUsageUsers",
"func_call": "mastodon.instance_nodeinfo().usage.users",
"masto_doc_link": "https://github.com/jhass/nodeinfo",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Nodeinfo user count statistics.",
"fields": {
"total": {
"description": "The total number of accounts that have been created on this instance.",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
]
},
"activeMonth": {
"description": "Number of users that have been active, by some definition (Mastodon: Have logged in at least once) in the last month.",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
]
},
"activeHalfyear": {
"description": "Number of users that have been active, by some definition (Mastodon: Have logged in at least once) in the last half year.",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
]
}
}
},
{
"name": "Nodeinfo metadata",
"python_name": "NodeinfoMetadata",
"masto_doc_link": "https://github.com/jhass/nodeinfo",
"func_call": "mastodon.instance_nodeinfo().metadata",
"description": "Nodeinfo extra metadata.",
"fields": {}
},
{
"name": "Activity",
"python_name": "Activity",
"func_call": "mastodon.instance_activity()[0]",
"masto_doc_link": "https://docs.joinmastodon.org/methods/instance/#activity",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Information about recent activity on an instance.",
"fields": {
"week": {
"description": "Date of the first day of the week the stats were collected for",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.1.2",
"added"
]
]
},
"logins": {
"description": "Number of users that logged in that week",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.1.2",
"added"
]
]
},
"registrations": {
"description": "Number of new users that week",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.1.2",
"added"
]
]
},
"statuses": {
"description": "Number of statuses posted that week",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.1.2",
"added"
]
]
}
}
},
{
"name": "Report",
"python_name": "AdminReport",
"func_call": "mastodon.admin_reports()[0]",
"func_alternate_acc": true,
"func_call_real": "mastodon.admin_reports()[-1]",
"func_call_additional": "mastodon.admin_reports(resolved=True)[-1]",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Report/",
"masto_doc_link_additional": "https://docs.joinmastodon.org/entities/Report/",
"manual_update": false,
"description": "Information about a report that has been filed against a user.",
"fields": {
"id": {
"description": "Id of the report",
"field_type": "IdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"action_taken": {
"description": "True if a moderator or admin has processed the report, False otherwise.",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"comment": {
"description": "Text comment submitted with the report",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"created_at": {
"description": "Time at which this report was created, as a datetime object",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"updated_at": {
"description": "Last time this report has been updated, as a datetime object",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"account": {
"description": "Account of the user that filed this report",
"field_type": "Account",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"target_account": {
"description": "Account that has been reported with this report",
"field_type": "Account",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"assigned_account": {
"description": "If the report as been assigned to an account, that Account (None if not)",
"field_type": "AdminAccount",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"action_taken_by_account": {
"description": "Account that processed this report",
"field_type": "AdminAccount",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"statuses": {
"description": "List of Statuses attached to the report",
"field_type": "EntityList",
"field_subtype": "Status",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"action_taken_at": {
"description": "When an action was taken, if this report is currently resolved.",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"category": {
"description": "The category under which the report is classified.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "ReportReasonEnum",
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
},
"forwarded": {
"description": "Whether a report was forwarded to a remote instance.",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
},
"rules": {
"description": "Rules attached to the report, for context.",
"field_type": "EntityList",
"field_subtype": "Rule",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Push subscription",
"python_name": "WebPushSubscription",
"func_call": "mastodon.push_subscription()",
"func_call_real": "mastodon.push_subscription_set(\"http://halcy.de/\",mastodon.push_subscription_generate_keys()[1],follow_events=True)",
"masto_doc_link": "https://docs.joinmastodon.org/entities/WebPushSubscription/",
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Information about the logged-in users web push subscription for the authenticated application.",
"fields": {
"id": {
"description": "Id of the push subscription",
"field_type": "IdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.4.0",
"added"
]
],
"enum": null
},
"endpoint": {
"description": "Endpoint URL for the subscription",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "URL",
"version_history": [
[
"2.4.0",
"added"
]
],
"enum": null
},
"server_key": {
"description": "Server pubkey used for signature verification",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.4.0",
"added"
]
],
"enum": null
},
"alerts": {
"description": "Subscribed events - object that may contain various keys, with value True if webpushes have been requested for those events.",
"field_type": "PushSubscriptionAlert",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.4.0",
"added"
],
[
"2.8.0",
"added poll`"
],
[
"3.1.0",
"added follow_request`"
],
[
"3.3.0",
"added status"
],
[
"3.5.0",
"added update and admin.sign_up"
],
[
"4.0.0",
"added admin.report"
]
],
"enum": null
},
"policy": {
"description": "Which sources should generate webpushes.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"enum": {
"all": "All sources generate pushes.",
"none": "Don't actually send pushes.",
"follower": "Pushes should be generated for events originating from accounts that follow the logged in user.",
"followed": "Pushes should be generated for events originating from accounts the logged in user follows."
},
"version_history": [
[
"2.4.0",
"added"
]
]
}
}
},
{
"name": "Push subscription alert",
"python_name": "WebPushSubscriptionAlerts",
"func_call": "mastodon.push_subscription().alerts",
"func_call_real": "mastodon_soc.push_subscription_set(\"http://halcy.de/\",mastodon_soc.push_subscription_generate_keys()[1],follow_events=True).alerts",
"masto_doc_link": "https://docs.joinmastodon.org/entities/WebPushSubscription/",
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "Information about alerts as part of a push subscription.",
"fields": {
"follow": {
"description": "True if push subscriptions for follow events have been requested, false or not present otherwise.",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.4.0",
"added"
]
],
"enum": null
},
"favourite": {
"description": "True if push subscriptions for favourite events have been requested, false or not present otherwise.",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.4.0",
"added"
]
],
"enum": null
},
"reblog": {
"description": "True if push subscriptions for reblog events have been requested, false or not present otherwise.",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.4.0",
"added"
]
],
"enum": null
},
"mention": {
"description": "True if push subscriptions for mention events have been requested, false or not present otherwise.",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.4.0",
"added"
]
],
"enum": null
},
"poll": {
"description": "True if push subscriptions for poll events have been requested, false or not present otherwise.",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.8.0",
"added"
]
],
"enum": null
},
"follow_request": {
"description": "True if push subscriptions for follow request events have been requested, false or not present otherwise.",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.4.0",
"added"
]
],
"enum": null
},
"status": {
"description": "True if push subscriptions for status creation (watched users only) events have been requested, false or not present otherwise.",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.1.0",
"added"
]
],
"enum": null
},
"update": {
"description": "True if push subscriptions for status update (edit) events have been requested, false or not present otherwise.",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.3.0",
"added"
]
],
"enum": null
},
"admin_sign_up": {
"description": "True if push subscriptions for sign up events have been requested, false or not present otherwise. Admins only.",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
},
"admin_report": {
"description": "True if push subscriptions for report creation events have been requested, false or not present otherwise. Admins only.",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Push notification",
"python_name": "PushNotification",
"func_call": "mastodon.push_subscription_decrypt_push(...)",
"manual_update": true,
"masto_doc_link": "https://docs.joinmastodon.org/entities/WebPushSubscription/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"description": "A single Mastodon push notification received via WebPush, after decryption.",
"fields": {
"access_token": {
"description": "Access token that can be used to access the API as the notified user",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.4.0",
"added"
]
]
},
"body": {
"description": "Text body of the notification",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.4.0",
"added"
]
]
},
"icon": {
"description": "URL to an icon for the notification",
"field_type": "str",
"field_subtype": null,
"field_structuretype": "URL",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.4.0",
"added"
]
]
},
"notification_id": {
"description": "ID that can be passed to notification() to get the full notification object,",
"field_type": "IdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.4.0",
"added"
]
]
},
"notification_type": {
"description": "String indicating the type of notification.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.4.0",
"added"
]
],
"enum": {
"follow": "A user followed the logged in user.",
"favourite": "A user favourited one of the logged in user's statuses.",
"reblog": "A user reblogged one of the logged in user's statuses.",
"mention": "A user mentioned the logged in user in a status.",
"poll": "A poll created or participated in by the logged in user has updated or ended",
"follow_request": "A user has requested to follow the logged in user.",
"status": " A watched user has posted a new status.",
"update": "A status the logged in user has reblogged has been edited.",
"admin_sign_up": "A new user has signed up on the instance.",
"admin_report": "A user has been reported to the instance's administrators."
}
},
"preferred_locale": {
"description": "The user's preferred locale",
"field_type": "str",
"field_subtype": null,
"field_structuretype": "TwoLetterLanguageCodeEnum",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.4.0",
"added"
]
]
},
"title": {
"description": "Title for the notification",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.4.0",
"added"
]
]
}
}
},
{
"name": "Preference",
"python_name": "Preferences",
"func_call": "mastodon.preferences()",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Preferences/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "The logged in users preferences.",
"fields": {
"posting:default:visibility": {
"python_name": "posting_default_visibility",
"description": "Default visibility for new posts. Equivalent to CredentialAccount#source\\[privacy\\]().",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.8.0",
"added"
]
],
"enum": {
"public": "Public post",
"unlisted": "Unlisted post",
"private": "Followers-only post",
"direct": "Direct post"
}
},
"posting:default:sensitive": {
"python_name": "posting_default_sensitive",
"description": "Default sensitivity flag for new posts. Equivalent to CredentialAccount#source\\[sensitive\\]().",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.8.0",
"added"
]
],
"enum": null
},
"posting:default:language": {
"python_name": "posting_default_language",
"description": "Default language for new posts. Equivalent to CredentialAccount#source\\[language\\]()",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"field_structuretype": "TwoLetterLanguageCodeEnum",
"version_history": [
[
"2.8.0",
"added"
]
],
"enum": null
},
"reading:expand:media": {
"python_name": "reading_expand_media",
"description": "String indicating whether media attachments should be automatically displayed or blurred/hidden.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.8.0",
"added"
]
],
"enum": {
"default": "Hide media marked as sensitive",
"show_all": "Always show all media by default, regardless of sensitivity",
"hide_all": "Always hide all media by default, regardless of sensitivity"
}
},
"reading:expand:spoilers": {
"python_name": "reading_expand_spoilers",
"description": "Boolean indicating whether CWs should be expanded by default.",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.8.0",
"added"
]
],
"enum": null
},
"reading:autoplay:gifs": {
"python_name": "reading_autoplay_gifs",
"description": "Boolean indicating whether gifs should be autoplayed (True) or not (False)",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.8.0",
"added"
]
]
}
}
},
{
"name": "Featured tag",
"python_name": "FeaturedTag",
"func_call": "mastodon.featured_tags()[0]",
"masto_doc_link": "https://docs.joinmastodon.org/entities/FeaturedTag/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "A tag featured on a users profile.",
"fields": {
"id": {
"description": "The featured tags id",
"field_type": "IdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
],
"enum": null
},
"name": {
"description": "The featured tags name (without leading #)",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
],
"enum": null
},
"statuses_count": {
"description": "Number of publicly visible statuses posted with this hashtag that this instance knows about",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
],
"enum": null
},
"last_status_at": {
"description": "The last time a public status containing this hashtag was added to this instance's database (can be None if there are none)",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
],
"enum": null
},
"url": {
"description": "A link to all statuses by a user that contain this hashtag.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "URL",
"version_history": [
[
"3.3.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Read marker",
"python_name": "Marker",
"func_call": "mastodon.markers_get()[\"home\"]",
"masto_doc_link": "https://docs.joinmastodon.org/entities/Marker/",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": false,
"manual_update": false,
"description": "A read marker indicating where the logged in user has left off reading a given timeline.",
"fields": {
"last_read_id": {
"description": "ID of the last read object in the timeline",
"field_type": "IdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
],
"enum": null
},
"version": {
"description": "A counter that is incremented whenever the marker is set to a new status",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
],
"enum": null
},
"updated_at": {
"description": "The time the marker was last set, as a datetime object",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.0.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Announcement",
"python_name": "Announcement",
"func_call": "mastodon.announcements()[0]",
"func_alternate_acc": true,
"masto_doc_link": "https://docs.joinmastodon.org/entities/Announcement/",
"func_call_real": null,
"func_call_additional": null,
"manual_update": false,
"description": "An announcement sent by the instances staff.",
"fields": {
"id": {
"description": "The annoucements id",
"field_type": "IdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.1.0",
"added"
]
],
"enum": null
},
"content": {
"description": "The contents of the annoucement, as an html string",
"field_type": "str",
"field_subtype": null,
"field_structuretype": "HTML",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.1.0",
"added"
]
],
"enum": null
},
"starts_at": {
"description": "The annoucements start time, as a datetime object. Can be None",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"3.1.0",
"added"
]
],
"enum": null
},
"ends_at": {
"description": "The annoucements end time, as a datetime object. Can be None",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"3.1.0",
"added"
]
],
"enum": null
},
"all_day": {
"description": "Boolean indicating whether the annoucement represents an \"all day\" event",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.1.0",
"added"
]
],
"enum": null
},
"published_at": {
"description": "The annoucements publish time, as a datetime object",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.1.0",
"added"
]
],
"enum": null
},
"updated_at": {
"description": "The annoucements last updated time, as a datetime object",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.1.0",
"added"
]
],
"enum": null
},
"read": {
"description": "A boolean indicating whether the logged in user has dismissed the annoucement",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.1.0",
"added"
]
],
"enum": null
},
"mentions": {
"description": "Users mentioned in the annoucement",
"field_type": "EntityList",
"field_subtype": "Mention",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.1.0",
"added"
]
],
"enum": null
},
"tags": {
"description": "Hashtags mentioned in the announcement",
"field_type": "EntityList",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.1.0",
"added"
]
],
"enum": null
},
"emojis": {
"description": "Custom emoji used in the annoucement",
"field_type": "EntityList",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.1.0",
"added"
]
],
"enum": null
},
"reactions": {
"description": "Reactions to the annoucement",
"field_type": "EntityList",
"field_subtype": "Reaction",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.1.0",
"added"
]
],
"enum": null
},
"statuses": {
"description": "Statuses linked in the announcement text.",
"field_type": "EntityList",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.1.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Announcement reaction",
"python_name": "Reaction",
"func_call": "mastodon.announcements()[0].reactions[0]",
"func_alternate_acc": true,
"masto_doc_link": "https://docs.joinmastodon.org/entities/Reaction/",
"func_call_real": null,
"func_call_additional": null,
"manual_update": false,
"description": "A reaction to an announcement.",
"fields": {
"name": {
"description": "Name of the custom emoji or unicode emoji of the reaction",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.1.0",
"added"
]
],
"enum": null
},
"count": {
"description": "Reaction counter (i.e. number of users who have added this reaction)",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.1.0",
"added"
]
],
"enum": null
},
"me": {
"description": "True if the logged-in user has reacted with this emoji, false otherwise",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.1.0",
"added"
]
],
"enum": null
},
"url": {
"description": "URL for the custom emoji image",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "URL",
"version_history": [
[
"3.1.0",
"added"
]
],
"enum": null
},
"static_url": {
"description": "URL for a never-animated version of the custom emoji image",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "URL",
"version_history": [
[
"3.1.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Familiar follower",
"python_name": "FamiliarFollowers",
"func_alternate_acc": true,
"func_call": "mastodon.account_familiar_followers(<account id>)[0]",
"func_call_real": "mastodon.account_familiar_followers(2)[0]",
"masto_doc_link": "https://docs.joinmastodon.org/entities/FamiliarFollowers/",
"func_call_additional": null,
"manual_update": false,
"description": "A follower of a given account that is also followed by the logged-in user.",
"fields": {
"id": {
"description": "ID of the account for which the familiar followers are being returned",
"field_type": "IdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
},
"accounts": {
"description": "List of Accounts of the familiar followers",
"field_type": "EntityList",
"field_subtype": "Account",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Admin account",
"python_name": "AdminAccount",
"func_call": "mastodon.admin_account(<account id>)",
"func_call_real": "mastodon.admin_account(1)",
"func_alternate_acc": true,
"masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Account/",
"func_call_additional": null,
"manual_update": false,
"description": "Admin variant of the Account entity, with some additional information.",
"fields": {
"id": {
"description": "The users id,",
"field_type": "IdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"username": {
"description": "The users username, no leading @",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"domain": {
"description": "The users domain",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"created_at": {
"description": "The time of account creation",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"email": {
"description": "For local users, the user's email",
"field_type": "str",
"field_subtype": null,
"field_structuretype": "Email",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"ip": {
"description": "For local users, the user's last known IP address",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"2.9.1",
"added"
],
[
"3.5.0",
"return type changed from String to [AdminIp]({{< relref \"entities/Admin_Ip\" >}}) due to a bug"
],
[
"4.0.0",
"bug fixed, return type is now a String again"
]
],
"enum": null
},
"role": {
"description": "The users role",
"field_type": "Role",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.9.1",
"added, returns a String (enumerable, oneOf `user` `moderator` `admin`)"
],
[
"4.0.0",
"now uses Role entity"
]
],
"enum": null
},
"confirmed": {
"description": "For local users, False if the user has not confirmed their email, True otherwise",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"suspended": {
"description": "Boolean indicating whether the user has been suspended",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"silenced": {
"description": "Boolean indicating whether the user has been silenced",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"disabled": {
"description": "For local users, boolean indicating whether the user has had their login disabled",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"approved": {
"description": "For local users, False if the user is pending, True otherwise",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"locale": {
"description": "For local users, the locale the user has set,",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "TwoLetterLanguageCodeEnum",
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"invite_request": {
"description": "If the user requested an invite, the invite request comment of that user.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"invited_by_account_id": {
"description": "Present if the user was invited by another user and set to the inviting users id.",
"field_type": "IdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"account": {
"description": "The user's Account",
"field_type": "Account",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"sensitized": {
"description": "Undocumented. If you know what this means, please let me know.",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"help_wanted": true,
"version_history": [
[
"2.9.1",
"added"
]
]
},
"ips": {
"description": "All known IP addresses associated with this account.",
"field_type": "EntityList",
"field_subtype": "AdminIp",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
},
"created_by_application_id": {
"description": "Present if the user was created by an application and set to the application id.",
"field_type": "IdType",
"field_subtype": null,
"is_optional": true,
"is_nullable": false,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
},
"invited_by_account_id ": {
"description": "Present if the user was created via invite and set to the inviting users id.",
"field_type": "IdType",
"field_subtype": null,
"is_optional": true,
"is_nullable": false,
"version_history": [
[
"2.9.1",
"added"
]
],
"enum": null
}
}
},
{
"name": "Admin account IP",
"python_name": "AdminIp",
"func_call": "mastodon.admin_account(<account id>).ips[0]",
"func_call_real": "mastodon.admin_account(1).ips[0]",
"func_alternate_acc": true,
"masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Ip/",
"func_call_additional": null,
"manual_update": false,
"description": "An IP address used by some user or other instance, visible as part of some admin APIs.",
"fields": {
"ip": {
"description": "The IP address.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
},
"used_at": {
"description": "The timestamp of when the IP address was last used for this account.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Admin measure",
"python_name": "AdminMeasure",
"func_call": "mastodon.admin_measures(datetime.now() - timedelta(hours=24*5), datetime.now(), interactions=True)[0]",
"func_alternate_acc": true,
"masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Measure/",
"func_call_real": null,
"func_call_additional": null,
"manual_update": false,
"description": "A measurement, such as the number of active users, as returned by the admin reporting API.",
"fields": {
"key": {
"description": "Name of the measure returned",
"field_type": "str",
"field_subtype": null,
"field_structuretype": "AdminMeasureTypeEnum",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": {
"active_users": "Total active users on your instance within the time period",
"new_users": "Users who joined your instance within the time period",
"interactions": "Total interactions (favourites, boosts, replies) on local statuses within the time period",
"opened_reports": "Total reports filed within the time period",
"resolved_reports": "Total reports resolved within the time period",
"tag_accounts": "Total accounts who used a tag in at least one status within the time period",
"tag_uses": "Total statuses which used a tag within the time period",
"tag_servers": "Total remote origin servers for statuses which used a tag within the time period",
"instance_accounts": "Total accounts originating from a remote domain within the time period",
"instance_media_attachments": "Total space used by media attachments from a remote domain within the time period",
"instance_reports": "Total reports filed against accounts from a remote domain within the time period",
"instance_statuses": "Total statuses originating from a remote domain within the time period",
"instance_follows": "Total accounts from a remote domain followed by a local user within the time period",
"instance_followers": "Total local accounts followed by accounts from a remote domain within the time period"
}
},
"unit": {
"description": "Unit for the measure, if available",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
},
"total": {
"description": "Value of the measure returned",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
},
"human_value": {
"description": "Human readable variant of the measure returned",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
},
"previous_total": {
"description": "Previous measurement period value of the measure returned, if available",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
},
"data": {
"description": "A list of AdminMeasureData with the measure broken down by date",
"field_type": "EntityList",
"field_subtype": "AdminMeasureData",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Admin measure data",
"python_name": "AdminMeasureData",
"func_call": "mastodon.admin_measures(datetime.now() - timedelta(hours=24*5), datetime.now(), active_users=True)[0].data[0]",
"func_alternate_acc": true,
"masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Measure/",
"func_call_real": null,
"func_call_additional": null,
"manual_update": false,
"description": "A single row of data for an admin reporting api measurement.",
"fields": {
"date": {
"description": "Date for this row",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
},
"value": {
"description": "Value of the measure for this row",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Admin dimension",
"python_name": "AdminDimension",
"func_call": "mastodon.admin_dimensions(datetime.now() - timedelta(hours=24*5), datetime.now(), languages=True)[0]",
"func_alternate_acc": true,
"masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Dimension/",
"func_call_real": null,
"func_call_additional": null,
"manual_update": false,
"description": "A qualitative measurement about the server, as returned by the admin reporting api.",
"fields": {
"key": {
"description": "Name of the dimension returned",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
},
"data": {
"description": "A list of data AdminDimensionData objects",
"field_type": "EntityList",
"field_subtype": "AdminDimensionData",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Admin dimension data",
"python_name": "AdminDimensionData",
"func_call": "mastodon.admin_dimensions(datetime.now() - timedelta(hours=24*5), datetime.now(), languages=True)[0].data[0]",
"func_alternate_acc": true,
"masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Dimension/",
"func_call_real": null,
"func_call_additional": null,
"manual_update": false,
"description": "A single row of data for qualitative measurements about the server, as returned by the admin reporting api.",
"fields": {
"key": {
"description": "category for this row",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
},
"human_key": {
"description": "Human readable name for the category for this row, when available",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
},
"value": {
"description": "Numeric value for the category",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Admin retention",
"python_name": "AdminRetention",
"func_call": "mastodon.admin_retention(datetime.now() - timedelta(hours=24*5), datetime.now())[0]",
"func_alternate_acc": true,
"masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Cohort/",
"func_call_real": null,
"func_call_additional": null,
"manual_update": false,
"description": "User retention data for a given cohort, as returned by the admin reporting api.",
"fields": {
"period": {
"description": "Starting time of the period that the data is being returned for",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
]
},
"frequency": {
"description": "Time resolution (day or month) for the returned data",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
]
},
"data": {
"description": "List of AdminCohort objects",
"field_type": "EntityList",
"field_subtype": "AdminCohort",
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
]
}
}
},
{
"name": "Admin retention data",
"python_name": "AdminCohort",
"func_call": "mastodon.admin_retention(datetime.now() - timedelta(hours=24*5), datetime.now())[0].data[0]",
"func_alternate_acc": true,
"masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Cohort/",
"func_call_real": null,
"func_call_additional": null,
"manual_update": false,
"description": "A single data point regarding user retention for a given cohort, as returned by the admin reporting api.",
"fields": {
"date": {
"description": "Date for this entry",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
]
},
"rate": {
"description": "Fraction of users retained",
"field_type": "float",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
]
},
"value": {
"description": "Absolute number of users retained",
"field_type": "int",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"3.5.0",
"added"
]
]
}
}
},
{
"name": "Admin domain block",
"python_name": "AdminDomainBlock",
"func_call": "mastodon_ico_admin.admin_domain_blocks()[0]",
"func_alternate_acc": true,
"masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_DomainBlock/",
"func_call_real": null,
"func_call_additional": null,
"manual_update": false,
"description": "A domain block, as returned by the admin API.",
"fields": {
"id": {
"description": "The ID of the DomainBlock in the database.",
"field_type": "IdType",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
},
"domain": {
"description": "The domain that is not allowed to federate.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
},
"created_at": {
"description": "When the domain was blocked from federating.",
"field_type": "datetime",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
},
"severity": {
"description": "The policy to be applied by this domain block.",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"field_structuretype": "AdminDomainLimitEnum",
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": {
"silence": "Users from this domain will be hidden from timelines, threads, and notifications, except for followed users.",
"suspend": "Incoming messages from this domain will be rejected and dropped entirely.",
"noop": "Do nothing to statuses. May be used to only media-reject or report-reject."
}
},
"reject_media": {
"description": "Whether to reject media attachments from this domain",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
},
"reject_reports": {
"description": "Whether to reject reports from this domain",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
},
"private_comment": {
"description": "A private comment (visible only to other moderators) for the domain block",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
},
"public_comment": {
"description": "A public comment (visible to either all users, or the whole world) for the domain block",
"field_type": "str",
"field_subtype": null,
"is_optional": false,
"is_nullable": true,
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
},
"obfuscate": {
"description": "Whether to obfuscate public displays of this domain block",
"field_type": "bool",
"field_subtype": null,
"is_optional": false,
"is_nullable": false,
"version_history": [
[
"4.0.0",
"added"
]
],
"enum": null
}
}
},
{
"name": "Admin email block",
"python_name": "AdminCanonicalEmailBlock",
"func_call": "TODO_TO_BE_IMPLEMENTED",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": null,
"manual_update": false,
"masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_CanonicalEmailBlock",
"description": "An e-mail block that has been set up to prevent certain e-mails to be used when signing up, via hash matching.",
"fields": {
"id": {
"description": "The ID of the email block in the database.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "IdType",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"canonical_email_hash": {
"description": "The SHA256 hash of the canonical email address.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "str",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
}
}
},
{
"name": "Admin domain allow",
"python_name": "AdminDomainAllow",
"func_call": "TODO_TO_BE_IMPLEMENTED",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": null,
"manual_update": false,
"masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_DomainAllow",
"description": "The opposite of a domain block, specifically allowing a domain to federate when the instance is in allowlist mode.",
"fields": {
"id": {
"description": "The ID of the DomainAllow in the database.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "IdType",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"domain": {
"description": "The domain that is allowed to federate.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "str",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"created_at": {
"description": "When the domain was allowed to federate.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "datetime",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
}
}
},
{
"name": "Admin email domain block",
"python_name": "AdminEmailDomainBlock",
"func_call": "TODO_TO_BE_IMPLEMENTED",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": null,
"manual_update": false,
"masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_EmailDomainBlock",
"description": "A block that has been set up to prevent e-mails from certain domains to be used when signing up.",
"fields": {
"id": {
"description": "The ID of the EmailDomainBlock in the database.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "IdType",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"domain": {
"description": "The email domain that is not allowed to be used for signups.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "str",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"created_at": {
"description": "When the email domain was disallowed from signups.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "datetime",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"history": {
"description": "Usage statistics for given days (typically the past week).",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "EntityList",
"field_subtype": "AdminEmailDomainBlockHistory",
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
}
}
},
{
"name": "Admin email signup attempt history",
"python_name": "AdminEmailDomainBlockHistory",
"func_call": "TODO_TO_BE_IMPLEMENTED",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": null,
"manual_update": false,
"masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_EmailDomainBlock",
"description": "Historic data about attempted signups using e-mails from a given domain.",
"fields": {
"day": {
"description": "The time (in day increments) for which this row of historical data is valid.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "datetime",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"accounts": {
"description": "The number of different account creation attempts that have been made.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "int",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"uses": {
"description": "The number of different ips used in account creation attempts.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "int",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
}
}
},
{
"name": "Admin IP block",
"python_name": "AdminIpBlock",
"func_call": "TODO_TO_BE_IMPLEMENTED",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": null,
"manual_update": false,
"masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_IpBlock",
"description": "An admin IP block, to prevent certain IP addresses or address ranges from accessing the instance.",
"fields": {
"id": {
"description": "The ID of the DomainBlock in the database.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "IdType",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"ip": {
"description": "The IP address range that is not allowed to federate.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "str",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"severity": {
"description": "The associated policy with this IP block.",
"enum": {
"sign_up_requires_approval": "Any signup from this IP range will create a pending account",
"sign_up_block": "Any signup from this IP range will be rejected",
"no_access": "Any activity from this IP range will be rejected entirely"
},
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "str",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"comment": {
"description": "The recorded reason for this IP block.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "str",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"created_at": {
"description": "When the IP block was created.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "datetime",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"expires_at": {
"description": "When the IP block will expire.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "datetime",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": true
}
}
},
{
"name": "Domain block",
"python_name": "DomainBlock",
"func_call": "TODO_TO_BE_IMPLEMENTED",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": null,
"manual_update": false,
"masto_doc_link": "https://docs.joinmastodon.org/entities/DomainBlock",
"description": "A domain block that has been implemented by instance staff, limiting the way posts from the blocked instance are handled.",
"fields": {
"domain": {
"description": "The domain which is blocked. This may be obfuscated or partially censored.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "str",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"digest": {
"description": "The SHA256 hash digest of the domain string.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "str",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"severity": {
"description": "The level to which the domain is blocked.",
"enum": {
"silence": "Users from this domain will be hidden from timelines, threads, and notifications, except for followed users.",
"suspend": "Incoming messages from this domain will be rejected and dropped entirely."
},
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "str",
"field_subtype": null,
"field_structuretype": "DomainLimitEnum",
"is_optional": false,
"is_nullable": false
},
"comment": {
"description": "An optional reason for the domain block.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "str",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
}
}
},
{
"name": "Extended instance description",
"python_name": "ExtendedDescription",
"func_call": "TODO_TO_BE_IMPLEMENTED",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": null,
"manual_update": false,
"masto_doc_link": "https://docs.joinmastodon.org/entities/ExtendedDescription",
"description": "An extended instance description that can contain HTML.",
"fields": {
"updated_at": {
"description": "A timestamp of when the extended description was last updated.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "datetime",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"content": {
"description": "The rendered HTML content of the extended description.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "str",
"field_subtype": null,
"field_structuretype": "HTML",
"is_optional": false,
"is_nullable": false
}
}
},
{
"name": "Filter keyword",
"python_name": "FilterKeyword",
"func_call": "TODO_TO_BE_IMPLEMENTED",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": null,
"manual_update": false,
"masto_doc_link": "https://docs.joinmastodon.org/entities/FilterKeyword",
"description": "A keyword that is being matched as part of a filter.",
"fields": {
"id": {
"description": "The ID of the FilterKeyword in the database.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "IdType",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"keyword": {
"description": "The phrase to be matched against.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "str",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"whole_word": {
"description": "Should the filter consider word boundaries? See implementation guidelines for filters().",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "bool",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
}
}
},
{
"name": "Filter status",
"python_name": "FilterStatus",
"func_call": "TODO_TO_BE_IMPLEMENTED",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": null,
"manual_update": false,
"masto_doc_link": "https://docs.joinmastodon.org/entities/FilterStatus",
"description": "A single status that is being matched as part of a filter.",
"fields": {
"id": {
"description": "The ID of the FilterStatus in the database.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "IdType",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"status_id": {
"description": "The ID of the Status that will be filtered.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "MaybeSnowflakeIdType",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
}
}
},
{
"name": "Identity proof",
"python_name": "IdentityProof",
"func_call": "TODO_TO_BE_IMPLEMENTED",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": null,
"manual_update": false,
"masto_doc_link": "https://docs.joinmastodon.org/entities/IdentityProof",
"description": "A cryptographic proof-of-identity.",
"fields": {
"provider": {
"description": "The name of the identity provider.",
"enum": null,
"version_history": [
[
"2.8.0",
"added"
]
],
"field_type": "str",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"provider_username": {
"description": "The account owner's username on the identity provider's service.",
"enum": null,
"version_history": [
[
"2.8.0",
"added"
]
],
"field_type": "str",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"updated_at": {
"description": "When the identity proof was last updated.",
"enum": null,
"version_history": [
[
"2.8.0",
"added"
]
],
"field_type": "datetime",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"proof_url": {
"description": "A link to a statement of identity proof, hosted by the identity provider.",
"enum": null,
"version_history": [
[
"2.8.0",
"added"
]
],
"field_type": "str",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"profile_url": {
"description": "The account owner's profile URL on the identity provider.",
"enum": null,
"version_history": [
[
"2.8.0",
"added"
]
],
"field_type": "str",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
}
}
},
{
"name": "Status source",
"python_name": "StatusSource",
"func_call": "TODO_TO_BE_IMPLEMENTED",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": null,
"manual_update": false,
"masto_doc_link": "https://docs.joinmastodon.org/entities/StatusSource",
"description": "The source data of a status, useful when editing a status.",
"fields": {
"id": {
"description": "ID of the status in the database.",
"enum": null,
"version_history": [
[
"3.5.0",
"added"
]
],
"field_type": "IdType",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"text": {
"description": "The plain text used to compose the status.",
"enum": null,
"version_history": [
[
"3.5.0",
"added"
]
],
"field_type": "str",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"spoiler_text": {
"description": "The plain text used to compose the status's subject or content warning.",
"enum": null,
"version_history": [
[
"3.5.0",
"added"
]
],
"field_type": "str",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
}
}
},
{
"name": "Suggestion",
"python_name": "Suggestion",
"func_call": "TODO_TO_BE_IMPLEMENTED",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": null,
"manual_update": false,
"masto_doc_link": "https://docs.joinmastodon.org/entities/Suggestion",
"description": "A follow suggestion.",
"fields": {
"source": {
"description": "The reason this account is being suggested.",
"enum": null,
"version_history": [
[
"3.4.0",
"added"
]
],
"field_type": "str",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"account": {
"description": "The account being recommended to follow.",
"enum": null,
"version_history": [
[
"3.4.0",
"added"
]
],
"field_type": "Account",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
}
}
},
{
"name": "Translation",
"python_name": "Translation",
"func_call": "TODO_TO_BE_IMPLEMENTED",
"func_call_real": null,
"func_call_additional": null,
"func_alternate_acc": null,
"manual_update": false,
"masto_doc_link": "https://docs.joinmastodon.org/entities/Translation",
"description": "A translation of a status.",
"fields": {
"content": {
"description": "The translated text of the status.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "str",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"detected_source_language": {
"description": "The language of the source text, as auto-detected by the machine translation provider.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "str",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
},
"provider": {
"description": "The service that provided the machine translation.",
"enum": null,
"version_history": [
[
"4.0.0",
"added"
]
],
"field_type": "str",
"field_subtype": null,
"field_structuretype": null,
"is_optional": false,
"is_nullable": false
}
}
}
]
Reference in New Issue View Git Blame Kopiuj bezpośredni odnośnik