List Lemmy communities
List Lemmy communities, local or federated, in the order asked for.
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.
`local` reads only this instance's own items; `all` includes federated items the instance has seen. Default: the endpoint's own listing.
one of: local, all
Order. `Scaled` and `Controversial` are refused by 0.18 instances.
one of: Active, Hot, New, Old, TopHour, TopSixHour, TopTwelveHour, TopDay, TopWeek, TopMonth, TopThreeMonths, TopSixMonths, TopNineMonths, TopYear, TopAll, MostComments, NewComments, Controversial, Scaled
Include NSFW communities. Default: false, as on the instance.
Page number, 1 to 100. Default: 1. An instance refuses pages past 100. Lemmy pages by number over a live order, so new or re-ranked items can shift a row onto the next page. Remove repeats by `id`.
≥ 1 · ≤ 100
Pass `page.nextCursor` from the previous response to get the next page. It only works with the same filters; do not send it with `page`.
min 1 chars · max 2048 chars
Rows per page, 1 to 50. Default: 10.
≥ 1 · ≤ 50
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.
Communities, in the order asked for.
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.
Description as Markdown.
Banner URL.
When the community was created.
When the community last changed.
Whether a moderator removed the community.
Whether the community was deleted.
Whether the community is hidden.
Whether only moderators may post.
`Public` or another visibility the instance reports.
Subscribers.
Subscribers on the community's own instance.
Posts in the community.
Comments in the community.
Active users in the community.
Active users today.
Active users this week.
Active users this month.
Active users in the last six months.
Moderators; null on list rows, which do not carry them.
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.
Discussion language ids; null on rows that do not carry them. The instance endpoint maps ids to language codes.
Pagination state for the current page.
Current page number. Lemmy pages by number over a live order, so new or re-ranked items can shift a row onto the next page. Remove repeats by `id`.
≥ 0
Whether a full page came back, so another page may exist. A last page that exactly fills the limit still sets true, and the next page is then empty.
Next page number; null when this page was short, so the list ended.
≥ 0
Cursor to pass in the next request; null when this page was short. It only works with the same filters.
True when a full page stopped at the instance's 100-page ceiling and rows may remain. False when the list ended because it ran out.
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/communities?instance=lemmy.world" \
-H "x-api-key: YOUR_API_KEY"Responses
Community list.