InsightSocial
GET /v1/lemmy/instancebeta

Lemmy Instance API

Get Lemmy instance version, counts, registration and federation settings.

20 credits a call · single call · failed calls free · 10 free calls to start

curl "https://api.insightsocial.app/v1/lemmy/instance?instance=<instance>" \
-H "x-api-key: $INSIGHTSOCIAL_API_KEY"
200 OKJSON
{
"success": true,
"platform": "lemmy",
"endpoint": "/v1/lemmy/instance",
"schema_version": "2",
"data": {
"<field>": "<value>"
},
"unavailable": [],
"credits_used": "<integer>"
}

Parameters

Query parameters for GET /v1/lemmy/instance. Send your key in the x-api-key header.

NameRequiredDescription
instanceYesThe Lemmy instance, e.g. lemmy.world. A URL on the instance is also accepted. Ids and counts belong to this instance.
includeNoExtra heavy parts to return: emoji, blockedUrls, taglines, comma-separated. Default: none; the site object can be megabytes of custom emoji.

Response

This endpoint is beta: data holds the platform's own fields under our naming rules (snake_case keys, string ids, ISO times where the platform gives a timestamp) rather than a unified post or profile, and those fields may change.

Every field, error and example is in the Lemmy Instance API reference.

How much does the Lemmy Instance API cost?

20 credits per successful call.

  • Failed calls are free

    A call that errors or finds nothing costs 0 credits.

  • Know the price first

    Add dry_run=1 and the response quotes the call without making it. Nothing is charged.

  • One balance

    API calls and Chrome extension exports share the same credits, on the free plan too.

Lemmy Instance API: frequently asked questions

Send GET /v1/lemmy/instance with the instance parameter and your key in the x-api-key header. Get Lemmy instance version, counts, registration and federation settings.