Get Lemmy instance
Get Lemmy instance version, counts, registration and federation settings.
Headers
Get your API keyAPI key (`sfk_...`)
The Lemmy instance, e.g. `lemmy.world`. A URL on the instance is also accepted. Ids and counts belong to this instance.
Extra heavy parts to return: `emoji`, `blockedUrls`, `taglines`, comma-separated. Default: none; the site object can be megabytes of custom emoji.
any of: emoji, blockedUrls, taglines (comma-separated)
Endpoint-specific response payload.
`found`, `not_found` (the entity is missing, or the host name does not resolve), `private` (the instance does not allow public lists) or `not_compatible` (the host is not a Lemmy instance, or its version does not serve this operation). See `reason`.
one of: found, not_found, private, not_compatible
The instance that was asked.
Why `lookupStatus` is not `found`, or null when it is `found`.
Machine-readable reason.
one of: instance_private, not_a_lemmy_instance, not_available, deleted, host_not_found
Plain-language explanation.
The site object when `lookupStatus` is `found`.
Instance name.
Short description.
Sidebar text as Markdown.
Icon URL.
Banner URL.
Canonical ActivityPub id.
When the instance was created.
When its settings last changed.
The instance host.
Software and version.
`lemmy`.
Version the instance reports.
How the instance handles registration.
`Open`, `RequireApplication` or `Closed`.
Whether an email verification is required.
The application question, when registration requires one.
Whether registration asks for a verification challenge.
Whether the instance is private, so it does not allow public lists.
Whether federation is on.
Whether downvotes are enabled.
Whether NSFW content is allowed.
Whether only administrators may create communities.
Whether the modlog hides moderator names.
Legal information.
The instance's default sort.
The instance's default post listing.
The request limits the instance publishes.
The instance's own search limit.
Searches allowed per window.
Window length in seconds.
Counts the instance publishes.
Registered users.
Posts.
Comments.
Communities.
Users active today.
Users active this week.
Users active this month.
Users active in the last six months.
Instance administrators with their counts.
User id on this instance.
Username without the host.
Display name.
Profile text as Markdown.
Avatar URL.
Banner URL.
Canonical ActivityPub id.
Host the account lives on.
`user@host`.
When the account was created.
When the profile last changed.
Whether the account is banned.
When the ban ends.
Whether the account was deleted.
Whether the account is a bot.
Whether the account lives on the instance asked.
Matrix id the user chose to publish.
Posts the user has made.
Comments the user has made.
Combined score of the user's posts, when the instance reports it.
Combined score of the user's comments, when the instance reports it.
Whether the user is an instance administrator.
Communities the user moderates; null when the answer did not carry them.
Community id on this instance.
Community name without the host.
Display title.
Canonical ActivityPub id.
Host the community lives on.
`name@host`.
Community icon URL.
Whether the community is NSFW.
Whether the community lives on the instance asked.
Every language the instance knows.
Language id used by `languageId`.
Two- or three-letter code, e.g. `en`.
English name.
The languages the instance discusses in.
Language id used by `languageId`.
Two- or three-letter code, e.g. `en`.
English name.
Taglines; null unless `include=taglines` was asked for.
Tagline text.
Custom emoji; null unless `include=emoji` was asked for.
Shortcode without colons.
Emoji image URL.
Alt text.
Category the instance files it under; null when empty.
Search keywords; null when the instance does not publish them.
URLs the instance blocks from its links; null unless `include=blockedUrls` was asked for.
The host's NodeInfo document; null when it is not available, in which case `site` is still returned.
The software the host reports.
Software name, e.g. `lemmy`.
Software version.
Usage counts.
Registered users.
Active users in six months.
Active users in a month.
Local posts.
Local comments.
Whether the host reports open registrations.
Metadata describing the request and billing outcome.
Unique request identifier for tracing this API call.
min 1 chars
Credits charged for this request.
≥ 0
Public API version that served the response.
one of: v1
Code example
curl "https://api.socialfetch.dev/v1/lemmy/instance?instance=lemmy.world" \
-H "x-api-key: YOUR_API_KEY"Responses
Instance.