Skip to content
Scrappa Get API key
Lemmy API 1 credit/request

Lemmy Community API Documentation

GET https://scrappa.co/api/lemmy/community

Lemmy Community API returns the public profile of a Lemmy community: name, title, description, actor id, subscriber and post counts, active user metrics, NSFW flag and publish date. A valid community with zero subscribers or an empty description is still a successful response.

Lemmy Community API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/lemmy/community
Auth header
x-api-key
Cost
1 credit/request
name = example
Response preview
200 OK
{
    "data": {
        "community": {
            "id": 2478,
            "icon": "https://lemmy.world/pictrs/image/abc123.jpeg",
            "name": "technology",
            "nsfw": false,
            "posts": 22225,
            "title": "Technology",
            "actor_id": "https://lemmy.world/c/technology",
            "comments": 970289,
            "published": "2019-04-25T12:00:00.000000Z",
            "description": "A community for technology news and discussion.",
            "subscribers": 88756,
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

1 optional filter available.

name string Required

Lemmy community name. Example: technology.

Example value example
instance string Optional

Lemmy instance hostname. Defaults to lemmy.world. The hostname must resolve to a public address; private, loopback and unresolvable hosts are rejected without charge.

Example value example

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "community": {
            "id": 2478,
            "icon": "https://lemmy.world/pictrs/image/abc123.jpeg",
            "name": "technology",
            "nsfw": false,
            "posts": 22225,
            "title": "Technology",
            "actor_id": "https://lemmy.world/c/technology",
            "comments": 970289,
            "published": "2019-04-25T12:00:00.000000Z",
            "description": "A community for technology news and discussion.",
            "subscribers": 88756,
            "users_active_day": 4727,
            "subscribers_local": 41267,
            "users_active_week": 9031,
            "users_active_month": 14620,
            "users_active_half_year": 29834
        }
    },
    "meta": {
        "billable": true,
        "endpoint_family": "community_detail"
    },
    "success": true
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

The name parameter is missing or invalid. This response is not billable.

{
    "errors": {
        "name": [
            "The name field is required."
        ]
    },
    "message": "The request validation failed"
}
404

Community Not Found

The requested Lemmy community was not found. This response is not billable.

{
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested Lemmy resource was not found."
    },
    "success": false
}
503

Upstream Unavailable

The Lemmy API is temporarily unavailable. This response is not billable.

{
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "The Lemmy API is temporarily unavailable. Please retry."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.