Skip to content

Instance

Public information about the instance.

object
domain
required

The domain that serves the instance.

string
name
required

The display name of the instance; the domain when the instance has none.

string
short_description

A one-paragraph summary of the instance, as plain text; omitted when there is none.

string
description

The full description of the instance, as plain text; omitted when there is none.

string
registrations
required
object
login_providers_only
required

Whether registration and sign-in are limited to the login providers now: the instance setting is on and at least one provider is enabled. While it is true, a password or a passkey signs nobody in, and neither can be set or added; both still confirm operations of a signed-in user.

boolean
version
required

The server version.

string
features
required

The identifiers of the features that this server offers now, in no particular order. Detect a feature by its identifier rather than by version. An identifier is listed only while its feature is on, so the list can change with the instance’s settings; it is never removed from the API or reused for something else. Ignore the identifiers you do not know. The identifiers:

  • voice_rooms: the voice chat rooms (/voice/...).
  • full_text_search: the full-text search of statuses (searchStatuses).
  • supporters: the supporter program and its plans (GET /instance/supporter_plans).
  • tips: one-time tips to the server’s operation (GET /instance/tip_amounts).
  • web_push: Web Push subscriptions (push_server_key).
  • translation: the translation of statuses through this server (translateStatus).
Array<string>
source_url
required

Where users get the source code of the running server (AGPL-3.0 section 13), as an https URL to read it at or a mailto URI to request it by email.

string format: uri
status_page_url

The https address of the instance’s status page, on a service apart from the server. Absent when the operator has not set one.

string format: uri
limits
required
object
timelines
required
object
federation
required
object
closure
object
sends_email
required

Whether the instance sends email (the server setting mail is not none). Without email, notifications come only in the app, so clients do not offer the email column of the notification settings (GET /preferences/notifications).

boolean
push_server_key

The instance’s VAPID public key (RFC 8292), an uncompressed P-256 point in unpadded base64url: the applicationServerKey that browsers subscribe with before putPushSubscription. Omitted when the instance sends no Web Push.

string
rules
required

The rules in effect, in order.

Array<object>

A rule of the instance. Its text and hint hold one value each, written in any language and the same in every locale. Reports cite it by id.

object
id
required

The ID of a resource, a UUIDv7 in its canonical string form.

string format: uuid
text
required

The rule, on one line, as plain text.

string
hint

An explanation of the rule, as plain text; omitted when there is none.

string
terms_url

The web client’s page of the instance’s terms of service (/about/terms), which needs no sign-in and shows GET /instance/documents/terms; omitted when the instance has none, so that clients do not link to it.

string format: uri
privacy_policy_url

The web client’s page of the instance’s privacy policy (/about/privacy), which needs no sign-in and shows GET /instance/documents/privacy_policy; omitted when the instance has none.

string format: uri
commerce_disclosure_url

The web client’s page of the commerce disclosures of the supporter plans (/about/commerce, the URL that the operators give the payment provider), which needs no sign-in and shows GET /instance/documents/commerce_disclosure; omitted when the instance has none.

string format: uri
supporters_enabled
required

Whether the supporter program is enabled: its plans (GET /instance/supporter_plans) and the subscriptions show only then.

boolean
tips_enabled
required

Whether the server takes tips, one-time payments to its operation with nothing in return: their amounts (GET /instance/tip_amounts) and the tips show only then.

boolean
supporter_list_visibility
required

Who may read something public about the instance, the value of the instance settings local_timeline_visibility, federated_timeline_visibility, domain_actions_visibility, domain_actions_rationale_visibility, and supporter_list_visibility: off, nobody, and the resource is a 404; signed_in, the users signed in to this server, and an anonymous request is a 401; everyone, everyone, anonymous visitors included.

string
Allowed values: off signed_in everyone
domain_actions_visibility
required

Who may read the list of moderated domains (GET /instance/domain_actions), the instance setting domain_actions_visibility: off, nobody (the list is a 404); signed_in, the users signed in to this server; everyone, anonymous visitors included. The about page shows the list only when it lets the viewer read it.

string
Allowed values: off signed_in everyone
external_reviews

The decision hooks in use: what the server sends to an external review before it accepts it. Absent when there is none. The information page states this.

Array<string>
Allowed values: inbound.status inbound.follow signup.check media.check local.status inbound.actor local.profile
external_review_scope
voice_enabled
required

Whether the voice chat rooms are on: the voice operations (/voice/...) answer 404 while they are off, and clients then show no entry to them.

boolean
article_authoring

Who may write new articles (createArticle): everyone (every local user who is not limited) or permission (only the users whose roles have create_articles). Always given.

string
Allowed values: everyone permission
voice_room_starters
required

Who may open voice chat rooms: everyone (every local user who is not limited) or permitted (only the users whose roles have start_voice_rooms). permitted while the voice chat is off.

string
Allowed values: everyone permitted
event_creators
required

Who may create events: everyone (every local user who is not limited) or permitted (only the users whose roles have create_events).

string
Allowed values: everyone permitted
full_text_search
required
object
theme

Schema: InstanceTheme

object
icon
object
logo
object
logo_dark
object
contact
object
thumbnail
object
search_indexing
required

Whether the instance lets search engines index its pages (the instance setting search_indexing). allow: the profiles and public posts of the accounts that are indexable; deny: no page. An account can deny what the instance allows, never the reverse.

string
Allowed values: allow deny
ai_usage
required

What the instance states to AI crawlers (the instance setting ai_usage). allow: no reservation; deny_training: no training of AI models; deny: no training and no use by AI search, assistants, and agents. An account can opt out of what the instance allows (ai_opt_out), never the reverse.

string
Allowed values: allow deny_training deny
link_cards
required

Whether the server fetches the pages that posts link to, for their link cards. While it is false, the server fetches nothing for link cards.

boolean
link_cards_ignore_robots_txt
required

Whether the fetches of link cards skip robots.txt. While it is true, the sites that posts link to cannot refuse those fetches in robots.txt; the directives of their pages still apply.

boolean
landing_fediverse_explanation
required

Whether the landing page (/, signed out) explains how the fediverse works: that an account here follows and is followed by people on other servers (the instance setting landing_fediverse_explanation).

boolean
landing_features
required

Whether the landing page shows what the software does on this instance, a sample of each feature that is on (the instance setting landing_features).

boolean
ux_measurement

Whether the server takes samples of how fast the web client responds (POST /client_measurements). While it is false, the server takes none and the client sends none.

boolean
ux_measurement_share

The percent of browser sessions whose web client sends its samples while ux_measurement is true: each session is drawn once, at this share.

integer
>= 1 <= 100
translation
required
object
auto_delete_limit

The server maximum of the automatic deletion of old posts, which the about page shows so that people know it before they sign up; absent when the server sets none.

Schema: AutoDeleteLimit

object
finance_visibility
required

How much of the instance’s costs everyone may read (the instance setting finance_visibility). private: nothing, and GET /instance/cost_totals is a 404; totals: the total of each currency by period; breakdown: the totals and their breakdown by provider and category. No level publishes the names, memos, or individual payments of the cost items.

string
Allowed values: private totals breakdown
income_visibility
required

How much of the instance’s income everyone may read (the instance setting income_visibility), apart from finance_visibility. private: nothing, and GET /instance/income_totals is a 404; totals: the net income of each currency by period; plans: also the number of members of each supporter plan now. No level publishes individual payments, the subscribers, the amounts of each plan, or the gross and the fees.

string
Allowed values: private totals plans
funding_meter

The funding meter of this month, which the about page shows; absent while the instance setting funding_meter_visibility is off or the month has no target.

Schema: FundingMeter

object
single_user
required

Whether the instance is a one-person server: the home of its operator alone, with nobody else to join. While it is true, registrations.mode is closed and both timelines are off, whatever the instance settings store. Clients also hide the suggestions of accounts, invites, the review of registrations, the sign-up blocks, and the visibility local: those operations answer a 404 of the type /api/v1/problems/single-user-mode, and a new local post is a 422.

boolean
single_user_account

The operator’s account of a one-person server, whose profile the web client shows people who are not signed in at the root address. Present only while single_user is true, and omitted when the account cannot be shown (it is suspended or deleted).

Schema: Account

object

Example generated

{
"domain": "example",
"name": "example",
"short_description": "example",
"description": "example",
"registrations": {},
"login_providers_only": true,
"version": "example",
"features": [
"example"
],
"source_url": "https://example.com",
"status_page_url": "https://example.com",
"limits": {},
"timelines": {},
"federation": {},
"closure": {},
"sends_email": true,
"push_server_key": "example",
"rules": [
{
"id": "01890a5d-ac96-774b-bcce-b302099a8057",
"text": "example",
"hint": "example"
}
],
"terms_url": "https://example.com",
"privacy_policy_url": "https://example.com",
"commerce_disclosure_url": "https://example.com",
"supporters_enabled": true,
"tips_enabled": true,
"supporter_list_visibility": "off",
"domain_actions_visibility": "off",
"external_reviews": [
"inbound.status"
],
"external_review_scope": {},
"voice_enabled": true,
"article_authoring": "everyone",
"voice_room_starters": "everyone",
"event_creators": "everyone",
"full_text_search": {},
"theme": {},
"icon": {},
"logo": {},
"logo_dark": {},
"contact": {},
"thumbnail": {},
"search_indexing": "allow",
"ai_usage": "allow",
"link_cards": true,
"link_cards_ignore_robots_txt": true,
"landing_fediverse_explanation": true,
"landing_features": true,
"ux_measurement": true,
"ux_measurement_share": 1,
"translation": {},
"auto_delete_limit": {},
"finance_visibility": "private",
"income_visibility": "private",
"funding_meter": {},
"single_user": true,
"single_user_account": {}
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site