Lemmy

Get Lemmy community

Get one Lemmy community with its counts, active users and moderators.

GET/v1/lemmy/community
1credit
x-api-keystringheader

API key (`sfk_...`)

Parameters
3
instancestringrequiredquery

The Lemmy instance, e.g. `lemmy.world`. A URL on the instance is also accepted. Ids and counts belong to this instance.

namestringoptionalquery

Community name, e.g. `technology`, or `technology@lemmy.world` to resolve a community on another instance. Prefer the community's home instance for counts.

idintegeroptionalquery

Community id on the chosen instance, e.g. `2478`.

≥ 1 · ≤ 2147483647

Response fields
58

Endpoint-specific response payload.

datalookupStatus
string

`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

datainstance
string

The instance that was asked.

Why `lookupStatus` is not `found`, or null when it is `found`.

datareasoncode
string

Machine-readable reason.

one of: instance_private, not_a_lemmy_instance, not_available, deleted, host_not_found

datareasonmessage
string

Plain-language explanation.

The community when `lookupStatus` is `found`; otherwise null.

datacommunityid
integer

Community id on this instance.

datacommunityname
string

Community name without the host.

datacommunitytitle
stringnullable

Display title.

datacommunityactorId
stringnullable

Canonical ActivityPub id.

datacommunityhost
stringnullable

Host the community lives on.

datacommunityhandle
stringnullable

`name@host`.

datacommunityicon
stringnullable

Community icon URL.

datacommunitynsfw
booleannullable

Whether the community is NSFW.

datacommunityisLocal
booleannullable

Whether the community lives on the instance asked.

datacommunitydescription
stringnullable

Description as Markdown.

datacommunitybanner
stringnullable

Banner URL.

datacommunitypublishedAt
stringnullable

When the community was created.

datacommunityupdatedAt
stringnullable

When the community last changed.

datacommunityremoved
booleannullable

Whether a moderator removed the community.

datacommunitydeleted
booleannullable

Whether the community was deleted.

datacommunityhidden
booleannullable

Whether the community is hidden.

datacommunitypostingRestrictedToMods
booleannullable

Whether only moderators may post.

datacommunityvisibility
stringnullable

`Public` or another visibility the instance reports.

datacommunitysubscriberCount
integernullable

Subscribers.

datacommunitylocalSubscriberCount
integernullable

Subscribers on the community's own instance.

datacommunitypostCount
integernullable

Posts in the community.

datacommunitycommentCount
integernullable

Comments in the community.

Active users in the community.

datacommunityactiveUsersday
integernullable

Active users today.

datacommunityactiveUsersweek
integernullable

Active users this week.

datacommunityactiveUsersmonth
integernullable

Active users this month.

datacommunityactiveUsershalfYear
integernullable

Active users in the last six months.

Moderators; null on list rows, which do not carry them.

datacommunitymoderators[]id
integer

User id on this instance.

datacommunitymoderators[]name
string

Username without the host.

datacommunitymoderators[]displayName
stringnullable

Display name.

datacommunitymoderators[]bio
stringnullable

Profile text as Markdown.

datacommunitymoderators[]avatar
stringnullable

Avatar URL.

datacommunitymoderators[]banner
stringnullable

Banner URL.

datacommunitymoderators[]actorId
stringnullable

Canonical ActivityPub id.

datacommunitymoderators[]host
stringnullable

Host the account lives on.

datacommunitymoderators[]handle
stringnullable

`user@host`.

datacommunitymoderators[]publishedAt
stringnullable

When the account was created.

datacommunitymoderators[]updatedAt
stringnullable

When the profile last changed.

datacommunitymoderators[]banned
booleannullable

Whether the account is banned.

datacommunitymoderators[]banExpiresAt
stringnullable

When the ban ends.

datacommunitymoderators[]deleted
booleannullable

Whether the account was deleted.

datacommunitymoderators[]isBot
booleannullable

Whether the account is a bot.

datacommunitymoderators[]isLocal
booleannullable

Whether the account lives on the instance asked.

datacommunitymoderators[]matrixUserId
stringnullable

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.

datacommunitylanguageIds[]
integeroptional

Metadata describing the request and billing outcome.

metarequestId
string

Unique request identifier for tracing this API call.

min 1 chars

metacreditsCharged
integer

Credits charged for this request.

≥ 0

metaversion
string

Public API version that served the response.

one of: v1

Code example

curl "https://api.socialfetch.dev/v1/lemmy/community?instance=lemmy.world&name=technology" \
  -H "x-api-key: YOUR_API_KEY"

Responses

Community.