InsightSocial
GET /v1/lemmy/searchbeta

Lemmy Search API

Search Lemmy posts, comments, communities, users or exact URLs; All and Comments can take longer.

20 credits a call · cursor pagination · failed calls free · 10 free calls to start

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

Parameters

Query parameters for GET /v1/lemmy/search. 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.
queryYesSearch term, 1 to 300 characters, in any language. Required, never empty and no control characters.
typeNoPosts (default), All (every kind), Comments (comment text), Communities, Users or Url (posts linking to an exact URL). All and Comments can take much longer than the other kinds.
sortNoOrder. Scaled and Controversial are refused by 0.18 instances.
communityNoCommunity name, e.g. technology, or technology@lemmy.world to resolve a community on another instance. Prefer the community's home instance for counts.
authorNoRestrict to one author, by username.
scopeNolocal reads only this instance's own items; all includes federated items the instance has seen. Default: the endpoint's own listing.
limitNoRows per page, 1 to 50. Default: 10.
cursorNoPass pagination.next_cursor from the previous response to get the next page. Keep the other parameters the same.

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 Search API reference.

How much does the Lemmy Search 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 Search API: frequently asked questions

Send GET /v1/lemmy/search with the instance and query parameters and your key in the x-api-key header. Search Lemmy posts, comments, communities, users or exact URLs; All and Comments can take longer.