kopia lustrzana https://github.com/halcy/Mastodon.py
5149 wiersze
195 KiB
JSON
5149 wiersze
195 KiB
JSON
[
|
|
{
|
|
"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()",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Account/",
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"fields": {
|
|
"id": {
|
|
"description": "Same as <numerical id>",
|
|
"field_type": "int",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"version_history": {
|
|
"0.1.0": "added"
|
|
},
|
|
"enum": null
|
|
},
|
|
"username": {
|
|
"description": "The username (what you @ them with)",
|
|
"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": "Account 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 people they follow",
|
|
"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 they have",
|
|
"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 they have",
|
|
"field_type": "int",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"version_history": {
|
|
"0.1.0": "added"
|
|
},
|
|
"enum": null
|
|
},
|
|
"note": {
|
|
"description": "Their bio",
|
|
"field_type": "str",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"version_history": {
|
|
"0.1.0": "added"
|
|
},
|
|
"enum": null
|
|
},
|
|
"url": {
|
|
"description": "Their URL; for example 'https://mastodon.social/users/<acct>'",
|
|
"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 their 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 their 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 their 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 their 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, a account dict of the account 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 account field dicts",
|
|
"field_type": "list",
|
|
"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": "list",
|
|
"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": "list",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false
|
|
},
|
|
"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]",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Account/",
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"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",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Role/",
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"fields": {
|
|
"id": {
|
|
"description": "The ID of the Role in the database.",
|
|
"field_type": "int",
|
|
"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\"]",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Account/",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"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": "list",
|
|
"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)",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Status/",
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"fields": {
|
|
"id": {
|
|
"description": "Numerical id of this toot",
|
|
"field_type": "int",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"version_history": {
|
|
"0.1.0": "added"
|
|
},
|
|
"enum": null
|
|
},
|
|
"uri": {
|
|
"description": "Descriptor for the toot 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 toot",
|
|
"field_type": "str",
|
|
"field_subtype": null,
|
|
"field_structuretype": "URL",
|
|
"is_optional": false,
|
|
"is_nullable": true,
|
|
"version_history": {
|
|
"0.1.0": "added"
|
|
}
|
|
},
|
|
"account": {
|
|
"description": "Account dict for the 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": "Numerical id of the toot this toot is in response to",
|
|
"field_type": "IdType",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": true,
|
|
"version_history": {
|
|
"0.1.0": "added"
|
|
}
|
|
},
|
|
"in_reply_to_account_id": {
|
|
"description": "Numerical id of the account this toot is in response to",
|
|
"field_type": "IdType",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": true,
|
|
"version_history": {
|
|
"0.1.0": "added"
|
|
}
|
|
},
|
|
"reblog": {
|
|
"description": "Denotes whether the toot is a reblog. If so, set to the original toot dict.",
|
|
"field_type": "Status",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": true,
|
|
"version_history": {
|
|
"0.1.0": "added"
|
|
}
|
|
},
|
|
"content": {
|
|
"description": "Content of the toot, as HTML: '<p>Hello from Python</p>'",
|
|
"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 toot",
|
|
"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 toot",
|
|
"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 toot 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 toot 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"
|
|
}
|
|
},
|
|
"mentions": {
|
|
"description": "A list of account dicts mentioned in the toot, as Mention dicts",
|
|
"field_type": "list",
|
|
"field_subtype": "Account",
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"version_history": {
|
|
"0.6.0": "added"
|
|
}
|
|
},
|
|
"media_attachments": {
|
|
"description": "A list of media dicts of attached files",
|
|
"field_type": "list",
|
|
"field_subtype": "MediaAttachment",
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"version_history": {
|
|
"0.6.0": "added"
|
|
},
|
|
"enum": null
|
|
},
|
|
"emojis": {
|
|
"description": "A list of custom emojis used in the toot, as Emoji dicts",
|
|
"field_type": "list",
|
|
"field_subtype": "CustomEmoji",
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"version_history": {
|
|
"2.0.0": "added"
|
|
}
|
|
},
|
|
"tags": {
|
|
"description": "A list of hashtag used in the toot, as Hashtag dicts",
|
|
"field_type": "list",
|
|
"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 dict for the client used to post the toot (Does not federate and is therefore always None for remote toots, can also be None for local toots for some legacy applications).",
|
|
"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 toot, 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, as card dict.",
|
|
"field_type": "PreviewCard",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": true,
|
|
"version_history": {
|
|
"2.6.0": "added"
|
|
}
|
|
},
|
|
"poll": {
|
|
"description": "A poll dict 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": "list",
|
|
"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]",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/StatusEdit/",
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"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 dict 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 media dicts with the attached media for this version of the status",
|
|
"field_type": "list",
|
|
"field_subtype": "MediaAttachment",
|
|
"is_optional": false,
|
|
"is_nullable": false
|
|
},
|
|
"emojis": {
|
|
"description": "List of custom emoji used in this version of the status.",
|
|
"field_type": "list",
|
|
"field_subtype": "CustomEmoji",
|
|
"is_optional": false,
|
|
"is_nullable": false
|
|
},
|
|
"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]",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/FilterResult/",
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"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": "list",
|
|
"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": "list",
|
|
"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]",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Mention/",
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"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": "int",
|
|
"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(9999,12,12))",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/ScheduledStatus/",
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"fields": {
|
|
"id": {
|
|
"description": "Scheduled toot ID (note: Not the id of the toot once it gets posted!)",
|
|
"field_type": "int",
|
|
"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 toot 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 toot, 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 media dicts for the attachments to the scheduled toot",
|
|
"field_type": "list",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"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(9999,12,12)).params",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/ScheduledStatus/",
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"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 toot this one is a reply to",
|
|
"field_type": "int",
|
|
"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 toot",
|
|
"field_type": "list",
|
|
"field_subtype": "str",
|
|
"is_optional": false,
|
|
"is_nullable": true,
|
|
"version_history": {
|
|
"2.7.0": "added"
|
|
},
|
|
"enum": null
|
|
},
|
|
"sensitive": {
|
|
"description": "Whether this toot 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 toot",
|
|
"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 toot",
|
|
"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 toot",
|
|
"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 toot",
|
|
"field_type": "int",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"version_history": {
|
|
"2.7.0": "added"
|
|
},
|
|
"enum": null
|
|
},
|
|
"poll": {
|
|
"description": "Poll parameters, as a poll dict",
|
|
"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": "list",
|
|
"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",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Poll/",
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"fields": {
|
|
"id": {
|
|
"description": "The polls ID",
|
|
"field_type": "int",
|
|
"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 you 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 as a list of poll option dicts",
|
|
"field_type": "list",
|
|
"field_subtype": "PollOption",
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"version_history": {
|
|
"2.8.0": "added"
|
|
},
|
|
"enum": null
|
|
},
|
|
"emojis": {
|
|
"description": "List of emoji dicts for all emoji used in answer strings,",
|
|
"field_type": "list",
|
|
"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": "list",
|
|
"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]",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Poll/",
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"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]",
|
|
"last_changed": "0.0.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,
|
|
"fields": {
|
|
"id": {
|
|
"description": "The ID of this conversation object",
|
|
"field_type": "int",
|
|
"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": "list",
|
|
"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]",
|
|
"last_changed": "0.0.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,
|
|
"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 usage history dicts for up to 7 days. Not present in statuses.",
|
|
"field_type": "list",
|
|
"field_subtype": "HashtagUsage",
|
|
"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]",
|
|
"last_changed": "0.0.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,
|
|
"fields": {
|
|
"day": {
|
|
"description": "Date of the day this history dict 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]",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/CustomEmoji/",
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"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()",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Application/",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"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]",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Relationship/",
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"fields": {
|
|
"id": {
|
|
"description": "Numerical id (same one as <numerical id>)",
|
|
"field_type": "int",
|
|
"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": "Have you enabled notifications for this user?",
|
|
"field_type": "bool",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"version_history": {
|
|
"3.3.0": "added"
|
|
},
|
|
"enum": null
|
|
},
|
|
"languages": {
|
|
"description": "Which languages are you following from this user?",
|
|
"field_type": "list",
|
|
"field_subtype": "str",
|
|
"field_structuretype": "TwoLetterLanguageCodeEnum",
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"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": "V1Filter",
|
|
"func_call": "mastodon.filters()[0]",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/V1_Filter/",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"fields": {
|
|
"id": {
|
|
"description": "Numerical id of the filter",
|
|
"field_type": "int",
|
|
"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,
|
|
"version_history": {
|
|
"2.4.3": "added"
|
|
},
|
|
"enum": null
|
|
},
|
|
"context": {
|
|
"description": "List of places where the filters are applied. Items can be: ('home', 'notifications', 'public', 'thread')",
|
|
"field_type": "list",
|
|
"field_subtype": "str",
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"field_structuretype": "TimelineEnum",
|
|
"version_history": {
|
|
"2.4.3": "added",
|
|
"3.1.0": "added `account`"
|
|
},
|
|
"enum": null
|
|
},
|
|
"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,
|
|
"version_history": {
|
|
"2.4.3": "added"
|
|
},
|
|
"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,
|
|
"version_history": {
|
|
"2.4.3": "added"
|
|
},
|
|
"enum": null
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "Notification",
|
|
"python_name": "Notification",
|
|
"func_call": "mastodon.notifications()[0]",
|
|
"last_changed": "0.0.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,
|
|
"fields": {
|
|
"id": {
|
|
"description": "id of the notification",
|
|
"field_type": "int",
|
|
"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 dict 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)",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Context/",
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"fields": {
|
|
"ancestors": {
|
|
"description": "A list of status dicts of statuses that this status is a reply to",
|
|
"field_type": "list",
|
|
"field_subtype": "Status",
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"version_history": {
|
|
"0.6.0": "added"
|
|
},
|
|
"enum": null
|
|
},
|
|
"descendants": {
|
|
"description": "A list of status dicts of statuses that are replies to this status",
|
|
"field_type": "list",
|
|
"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]",
|
|
"last_changed": "0.0.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,
|
|
"fields": {
|
|
"id": {
|
|
"description": "id of the list",
|
|
"field_type": "int",
|
|
"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",
|
|
"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]",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/MediaAttachment/",
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"fields": {
|
|
"id": {
|
|
"description": "The ID of the attachment.",
|
|
"field_type": "int",
|
|
"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": "Dictionary of two metadata dicts (see below), 'original' and 'small' (preview). 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' dict and a media 'colors' dict.",
|
|
"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",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/MediaAttachment/",
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"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",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/MediaAttachment/",
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"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",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/MediaAttachment/",
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"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",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/MediaAttachment/",
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"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",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/MediaAttachment/",
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"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",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/MediaAttachment/",
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"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
|
|
},
|
|
"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
|
|
},
|
|
"accent": {
|
|
"description": "Estimated accent colour for the attachment thumbnail",
|
|
"field_type": "str",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "Card",
|
|
"func_call": "mastodon.status_card(<status id>)",
|
|
"func_call_real": "mastodon.status_card(110447098625216345)",
|
|
"python_name": "PreviewCard",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/PreviewCard/",
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"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 of the embed",
|
|
"field_type": "str",
|
|
"field_subtype": null,
|
|
"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": "(optional) Blurhash of the preview image",
|
|
"field_type": "str",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": true,
|
|
"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
|
|
},
|
|
"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\")",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Search/",
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"fields": {
|
|
"accounts": {
|
|
"description": "List of account dicts resulting from the query",
|
|
"field_type": "list",
|
|
"field_subtype": "Account",
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"version_history": {
|
|
"1.1.0": "added"
|
|
},
|
|
"enum": null
|
|
},
|
|
"hashtags": {
|
|
"description": "List of hashtag dicts resulting from the query",
|
|
"field_type": "list",
|
|
"field_subtype": "Tag",
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"version_history": {
|
|
"1.1.0": "added",
|
|
"2.4.1": "v1/search deprecated because it returns Array of String. v2/search added which returns Array of Tag.",
|
|
"3.0.0": "v1 removed"
|
|
},
|
|
"enum": null
|
|
},
|
|
"statuses": {
|
|
"description": "List of status dicts resulting from the query",
|
|
"field_type": "list",
|
|
"field_subtype": "Status",
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"version_history": {
|
|
"1.1.0": "added"
|
|
},
|
|
"enum": null
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "Instance",
|
|
"python_name": "V1Instance",
|
|
"func_call": "mastodon.instance()",
|
|
"last_changed": "0.0.0",
|
|
"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,
|
|
"fields": {
|
|
"domain": {
|
|
"description": "The instances domain name",
|
|
"field_type": "str",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"version_history": {
|
|
"4.0.0": "added"
|
|
}
|
|
},
|
|
"description": {
|
|
"description": "A brief instance description set by the admin",
|
|
"field_type": "str",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"version_history": {
|
|
"1.1.0": "added"
|
|
},
|
|
"enum": null
|
|
},
|
|
"short_description": {
|
|
"description": "An even briefer instance description",
|
|
"field_type": "str",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"version_history": {
|
|
"2.9.2": "added"
|
|
},
|
|
"enum": null
|
|
},
|
|
"email": {
|
|
"description": "The admin contact email",
|
|
"field_type": "str",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"version_history": {
|
|
"1.1.0": "added"
|
|
},
|
|
"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 URL",
|
|
"field_type": "str",
|
|
"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 URLs dict, presently only 'streaming_api' with the stream websocket address.",
|
|
"field_type": "InstanceURLs",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"version_history": {
|
|
"1.4.2": "added"
|
|
},
|
|
"enum": null
|
|
},
|
|
"stats": {
|
|
"description": "A dictionary 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).",
|
|
"field_type": "InstanceStatistics",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false
|
|
},
|
|
"contact_account": {
|
|
"description": "Account dict of the primary contact for the instance",
|
|
"field_type": "Account",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false
|
|
},
|
|
"languages": {
|
|
"description": "Array of ISO 639-1 (two-letter) language codes the instance has chosen to advertise.",
|
|
"field_type": "list",
|
|
"field_subtype": "str",
|
|
"field_structuretype": "TwoLetterLanguageCodeEnum",
|
|
"is_optional": false,
|
|
"is_nullable": false
|
|
},
|
|
"registrations": {
|
|
"description": "Boolean indication whether registrations on this instance are open (True) or not (False)",
|
|
"field_type": "bool",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false
|
|
},
|
|
"approval_required": {
|
|
"description": "True if account approval is required when registering, False if not",
|
|
"field_type": "bool",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false
|
|
},
|
|
"rules": {
|
|
"description": "List of dicts with `id` and `text` fields, one for each server rule set by the admin",
|
|
"field_type": "list",
|
|
"field_subtype": "Rule",
|
|
"is_optional": false,
|
|
"is_nullable": false
|
|
},
|
|
"thumbnail": {
|
|
"description": "URL pointing to a banner image representing the instance.",
|
|
"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.",
|
|
"field_type": "bool",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"version_history": {
|
|
"3.1.4": "added"
|
|
}
|
|
},
|
|
"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 urls",
|
|
"python_name": "InstanceURLs",
|
|
"func_call": "mastodon.instance().urls",
|
|
"last_changed": "0.0.0",
|
|
"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,
|
|
"fields": {
|
|
"streaming_api": {
|
|
"description": "The Websockets URL for connecting to the streaming API.",
|
|
"field_type": "str",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"field_structuretype": "URL",
|
|
"version_history": {
|
|
"1.4.2": "added"
|
|
},
|
|
"enum": null
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "Instance statistics",
|
|
"python_name": "InstanceUsage",
|
|
"func_call": "mastodon.instance().stats",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Instance/",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"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 rule",
|
|
"python_name": "Rule",
|
|
"func_call": "mastodon.instance().rules[0]",
|
|
"last_changed": "0.0.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,
|
|
"fields": {
|
|
"id": {
|
|
"description": "An identifier for the rule.",
|
|
"field_type": "int",
|
|
"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 configuration",
|
|
"python_name": "InstanceConfiguration",
|
|
"func_call": "mastodon.instance().configuration",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/methods/instance/",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"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"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "Instance account configuration",
|
|
"python_name": "InstanceAccountConfiguration",
|
|
"func_call": "mastodon.instance().configuration.accounts",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/methods/instance/",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"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",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/methods/instance/",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"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 media attachment configuration",
|
|
"python_name": "InstanceMediaConfiguration",
|
|
"func_call": "mastodon.instance().configuration.media_attachments",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/methods/instance/",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"fields": {
|
|
"supported_mime_types": {
|
|
"description": "Mime types the instance accepts for media attachment uploads.",
|
|
"field_type": "list",
|
|
"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",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/methods/instance/",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"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()",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://github.com/jhass/nodeinfo",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"fields": {
|
|
"version": {
|
|
"description": "Version of the nodeinfo schemaw 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": "list",
|
|
"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",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://github.com/jhass/nodeinfo",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"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",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://github.com/jhass/nodeinfo",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"fields": {
|
|
"outbound": {
|
|
"description": "List of services that this instance can send messages to. On Mastodon, typically an empty list.",
|
|
"field_type": "list",
|
|
"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": "list",
|
|
"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",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://github.com/jhass/nodeinfo",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"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",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://github.com/jhass/nodeinfo",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"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",
|
|
"fields": {},
|
|
"last_changed": "3.0.0"
|
|
},
|
|
{
|
|
"name": "Activity",
|
|
"python_name": "Activity",
|
|
"func_call": "mastodon.instance_activity()[0]",
|
|
"last_changed": "0.0.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,
|
|
"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]",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Report/",
|
|
"manual_update": false,
|
|
"fields": {
|
|
"id": {
|
|
"description": "Numerical id of the report",
|
|
"field_type": "int",
|
|
"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 dict 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, account dict of 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 dict of the 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, as status dicts",
|
|
"field_type": "list",
|
|
"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": "list",
|
|
"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)",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/WebPushSubscription/",
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"fields": {
|
|
"id": {
|
|
"description": "Numerical id of the push subscription",
|
|
"field_type": "int",
|
|
"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",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/WebPushSubscription/",
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"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,
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/WebPushSubscription/",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"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()",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Preferences/",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"fields": {
|
|
"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": {
|
|
"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": {
|
|
"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": {
|
|
"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": {
|
|
"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": {
|
|
"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]",
|
|
"last_changed": "0.0.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,
|
|
"fields": {
|
|
"id": {
|
|
"description": "The featured tags id",
|
|
"field_type": "int",
|
|
"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\"]",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Marker/",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"func_alternate_acc": false,
|
|
"manual_update": false,
|
|
"fields": {
|
|
"last_read_id": {
|
|
"description": "ID of the last read object in the timeline",
|
|
"field_type": "int",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"version_history": [],
|
|
"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": [],
|
|
"enum": null
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "Announcement",
|
|
"python_name": "Announcement",
|
|
"func_call": "mastodon.announcements()[0]",
|
|
"func_alternate_acc": true,
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Announcement/",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"manual_update": false,
|
|
"fields": {
|
|
"id": {
|
|
"description": "The annoucements id",
|
|
"field_type": "int",
|
|
"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,
|
|
"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, as a list of mention dicts",
|
|
"field_type": "list",
|
|
"field_subtype": "Mention",
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"version_history": {
|
|
"3.1.0": "added"
|
|
},
|
|
"enum": null
|
|
},
|
|
"tags": {
|
|
"description": "Hashtags mentioned in the announcement, as a list of hashtag dicts",
|
|
"field_type": "list",
|
|
"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, as a list of emoji dicts",
|
|
"field_type": "list",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"version_history": {
|
|
"3.1.0": "added"
|
|
},
|
|
"enum": null
|
|
},
|
|
"reactions": {
|
|
"description": "Reactions to the annoucement, as a list of reaction dicts",
|
|
"field_type": "list",
|
|
"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": "list",
|
|
"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,
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Reaction/",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"manual_update": false,
|
|
"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]",
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/FamiliarFollowers/",
|
|
"func_call_additional": null,
|
|
"manual_update": false,
|
|
"fields": {
|
|
"id": {
|
|
"description": "ID of the account for which the familiar followers are being returned",
|
|
"field_type": "int",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"version_history": {
|
|
"3.5.0": "added"
|
|
},
|
|
"enum": null
|
|
},
|
|
"accounts": {
|
|
"description": "List of account dicts of the familiar followers",
|
|
"field_type": "list",
|
|
"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,
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Account/",
|
|
"func_call_additional": null,
|
|
"manual_update": false,
|
|
"fields": {
|
|
"id": {
|
|
"description": "The users id,",
|
|
"field_type": "int",
|
|
"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,
|
|
"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, as a standard account dict",
|
|
"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 does, 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": "list",
|
|
"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,
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Ip/",
|
|
"func_call_additional": null,
|
|
"manual_update": false,
|
|
"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,
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Measure/",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"manual_update": false,
|
|
"fields": {
|
|
"key": {
|
|
"description": "Name of the measure returned",
|
|
"field_type": "str",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false,
|
|
"version_history": {
|
|
"3.5.0": "added"
|
|
},
|
|
"enum": null
|
|
},
|
|
"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 dicts with the measure broken down by date, as below",
|
|
"field_type": "list",
|
|
"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,
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Measure/",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"manual_update": false,
|
|
"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,
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Dimension/",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"manual_update": false,
|
|
"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 dicts, as below",
|
|
"field_type": "list",
|
|
"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,
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Dimension/",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"manual_update": false,
|
|
"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,
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Cohort/",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"manual_update": false,
|
|
"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
|
|
},
|
|
"frequency": {
|
|
"description": "Time resolution (day or month) for the returned data",
|
|
"field_type": "str",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false
|
|
},
|
|
"data": {
|
|
"description": "List of data dicts, as below",
|
|
"field_type": "list",
|
|
"field_subtype": "AdminCohort",
|
|
"is_optional": false,
|
|
"is_nullable": false
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Cohort/",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"manual_update": false,
|
|
"fields": {
|
|
"date": {
|
|
"description": "Date for this entry",
|
|
"field_type": "datetime",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false
|
|
},
|
|
"rate": {
|
|
"description": "Fraction of users retained",
|
|
"field_type": "float",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false
|
|
},
|
|
"value": {
|
|
"description": "Absolute number of users retained",
|
|
"field_type": "int",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": false
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "Admin domain block",
|
|
"python_name": "AdminDomainBlock",
|
|
"func_call": "mastodon_ico_admin.admin_domain_blocks()[0]",
|
|
"func_alternate_acc": true,
|
|
"last_changed": "0.0.0",
|
|
"masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_DomainBlock/",
|
|
"func_call_real": null,
|
|
"func_call_additional": null,
|
|
"manual_update": false,
|
|
"fields": {
|
|
"id": {
|
|
"description": "The ID of the DomainBlock in the database.",
|
|
"field_type": "int",
|
|
"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": "DomainLimitEnum",
|
|
"version_history": {
|
|
"4.0.0": "added"
|
|
},
|
|
"enum": null
|
|
},
|
|
"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": "",
|
|
"field_type": "str",
|
|
"field_subtype": null,
|
|
"is_optional": false,
|
|
"is_nullable": true,
|
|
"version_history": {
|
|
"4.0.0": "added"
|
|
},
|
|
"enum": null
|
|
},
|
|
"public_comment": {
|
|
"description": "",
|
|
"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
|
|
}
|
|
}
|
|
}
|
|
] |