Lemmy

Get Lemmy user

Get one Lemmy user with counts, moderator roles and latest activity.

GET/v1/lemmy/user
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.

usernamestringoptionalquery

Username, e.g. `dessalines`, or `user@lemmy.ml` to resolve a user on another instance.

idintegeroptionalquery

User id on the chosen instance, e.g. `34`.

≥ 1 · ≤ 2147483647

Response fields
307

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 profile when `lookupStatus` is `found`; otherwise null.

datauserid
integer

User id on this instance.

datausername
string

Username without the host.

datauserdisplayName
stringnullable

Display name.

datauserbio
stringnullable

Profile text as Markdown.

datauseravatar
stringnullable

Avatar URL.

datauserbanner
stringnullable

Banner URL.

datauseractorId
stringnullable

Canonical ActivityPub id.

datauserhost
stringnullable

Host the account lives on.

datauserhandle
stringnullable

`user@host`.

datauserpublishedAt
stringnullable

When the account was created.

datauserupdatedAt
stringnullable

When the profile last changed.

datauserbanned
booleannullable

Whether the account is banned.

datauserbanExpiresAt
stringnullable

When the ban ends.

datauserdeleted
booleannullable

Whether the account was deleted.

datauserisBot
booleannullable

Whether the account is a bot.

datauserisLocal
booleannullable

Whether the account lives on the instance asked.

datausermatrixUserId
stringnullable

Matrix id the user chose to publish.

datauserpostCount
integernullable

Posts the user has made.

datausercommentCount
integernullable

Comments the user has made.

datauserpostScore
integernullable

Combined score of the user's posts, when the instance reports it.

datausercommentScore
integernullable

Combined score of the user's comments, when the instance reports it.

datauserisAdmin
booleannullable

Whether the user is an instance administrator.

Communities the user moderates; null when the answer did not carry them.

datausermoderates[]id
integer

Community id on this instance.

datausermoderates[]name
string

Community name without the host.

datausermoderates[]title
stringnullable

Display title.

datausermoderates[]actorId
stringnullable

Canonical ActivityPub id.

datausermoderates[]host
stringnullable

Host the community lives on.

datausermoderates[]handle
stringnullable

`name@host`.

datausermoderates[]icon
stringnullable

Community icon URL.

datausermoderates[]nsfw
booleannullable

Whether the community is NSFW.

datausermoderates[]isLocal
booleannullable

Whether the community lives on the instance asked.

The newest post, from the user lookup. Use the user posts endpoint for more.

dataposts[]id
integer

Post id on this instance.

dataposts[]apId
stringnullable

Canonical ActivityPub id.

dataposts[]title
stringnullable

Post title.

dataposts[]url
stringnullable

Link the post points at; null for a text post.

dataposts[]urlContentType
stringnullable

Content type of the link.

dataposts[]thumbnailUrl
stringnullable

Thumbnail URL.

dataposts[]nsfw
booleannullable

Whether the post is NSFW.

dataposts[]locked
booleannullable

Whether the post is locked.

dataposts[]removed
booleannullable

Whether a moderator removed it.

dataposts[]deleted
booleannullable

Whether it was deleted.

dataposts[]publishedAt
stringnullable

When it was posted.

dataposts[]updatedAt
stringnullable

When it last changed.

dataposts[]languageId
integernullable

Discussion language id.

dataposts[]isLocal
booleannullable

Whether it was posted on the instance asked.

dataposts[]score
integernullable

Votes up minus votes down.

dataposts[]upvotes
integernullable

Upvotes.

dataposts[]downvotes
integernullable

Downvotes.

dataposts[]commentCount
integernullable

Comments on the post.

The community it was posted in, with the counts the single-post answer carries.

dataposts[]communityid
integer

Community id on this instance.

dataposts[]communityname
string

Community name without the host.

dataposts[]communitytitle
stringnullable

Display title.

dataposts[]communityactorId
stringnullable

Canonical ActivityPub id.

dataposts[]communityhost
stringnullable

Host the community lives on.

dataposts[]communityhandle
stringnullable

`name@host`.

dataposts[]communityicon
stringnullable

Community icon URL.

dataposts[]communitynsfw
booleannullable

Whether the community is NSFW.

dataposts[]communityisLocal
booleannullable

Whether the community lives on the instance asked.

dataposts[]communitydescription
stringnullable

Description as Markdown.

dataposts[]communitybanner
stringnullable

Banner URL.

dataposts[]communitypublishedAt
stringnullable

When the community was created.

dataposts[]communityupdatedAt
stringnullable

When the community last changed.

dataposts[]communityremoved
booleannullable

Whether a moderator removed the community.

dataposts[]communitydeleted
booleannullable

Whether the community was deleted.

dataposts[]communityhidden
booleannullable

Whether the community is hidden.

dataposts[]communitypostingRestrictedToMods
booleannullable

Whether only moderators may post.

dataposts[]communityvisibility
stringnullable

`Public` or another visibility the instance reports.

dataposts[]communitysubscriberCount
integernullable

Subscribers.

dataposts[]communitylocalSubscriberCount
integernullable

Subscribers on the community's own instance.

dataposts[]communitypostCount
integernullable

Posts in the community.

dataposts[]communitycommentCount
integernullable

Comments in the community.

Active users in the community.

dataposts[]communityactiveUsersday
integernullable

Active users today.

dataposts[]communityactiveUsersweek
integernullable

Active users this week.

dataposts[]communityactiveUsersmonth
integernullable

Active users this month.

dataposts[]communityactiveUsershalfYear
integernullable

Active users in the last six months.

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

dataposts[]communitymoderators[]id
integer

User id on this instance.

dataposts[]communitymoderators[]name
string

Username without the host.

dataposts[]communitymoderators[]displayName
stringnullable

Display name.

dataposts[]communitymoderators[]bio
stringnullable

Profile text as Markdown.

dataposts[]communitymoderators[]avatar
stringnullable

Avatar URL.

dataposts[]communitymoderators[]banner
stringnullable

Banner URL.

dataposts[]communitymoderators[]actorId
stringnullable

Canonical ActivityPub id.

dataposts[]communitymoderators[]host
stringnullable

Host the account lives on.

dataposts[]communitymoderators[]handle
stringnullable

`user@host`.

dataposts[]communitymoderators[]publishedAt
stringnullable

When the account was created.

dataposts[]communitymoderators[]updatedAt
stringnullable

When the profile last changed.

dataposts[]communitymoderators[]banned
booleannullable

Whether the account is banned.

dataposts[]communitymoderators[]banExpiresAt
stringnullable

When the ban ends.

dataposts[]communitymoderators[]deleted
booleannullable

Whether the account was deleted.

dataposts[]communitymoderators[]isBot
booleannullable

Whether the account is a bot.

dataposts[]communitymoderators[]isLocal
booleannullable

Whether the account lives on the instance asked.

dataposts[]communitymoderators[]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.

dataposts[]communitylanguageIds[]
integeroptional

Who posted it; null on a modlog row, which does not carry the creator.

dataposts[]authorid
integer

User id on this instance.

dataposts[]authorname
string

Username without the host.

dataposts[]authordisplayName
stringnullable

Display name.

dataposts[]authorbio
stringnullable

Profile text as Markdown.

dataposts[]authoravatar
stringnullable

Avatar URL.

dataposts[]authorbanner
stringnullable

Banner URL.

dataposts[]authoractorId
stringnullable

Canonical ActivityPub id.

dataposts[]authorhost
stringnullable

Host the account lives on.

dataposts[]authorhandle
stringnullable

`user@host`.

dataposts[]authorpublishedAt
stringnullable

When the account was created.

dataposts[]authorupdatedAt
stringnullable

When the profile last changed.

dataposts[]authorbanned
booleannullable

Whether the account is banned.

dataposts[]authorbanExpiresAt
stringnullable

When the ban ends.

dataposts[]authordeleted
booleannullable

Whether the account was deleted.

dataposts[]authorisBot
booleannullable

Whether the account is a bot.

dataposts[]authorisLocal
booleannullable

Whether the account lives on the instance asked.

dataposts[]authormatrixUserId
stringnullable

Matrix id the user chose to publish.

dataposts[]body
stringnullable

Post text as Markdown.

Link preview; null when the instance found none.

dataposts[]embedtitle
stringnullable

Embedded page title.

dataposts[]embeddescription
stringnullable

Embedded page description.

dataposts[]embedvideoUrl
stringnullable

Embedded video URL.

dataposts[]altText
stringnullable

Alt text for the image.

Image details; null when the post has no image.

dataposts[]imagelink
string

Image URL.

dataposts[]imagewidth
integernullable

Width in pixels.

dataposts[]imageheight
integernullable

Height in pixels.

dataposts[]imagecontentType
stringnullable

Media type.

dataposts[]featuredInCommunity
booleannullable

Whether it is featured in its community.

dataposts[]featuredOnInstance
booleannullable

Whether it is featured on the instance.

dataposts[]newestCommentAt
stringnullable

When the newest comment was made.

dataposts[]isAdmin
booleannullable

Whether the author is an instance administrator.

dataposts[]isModerator
booleannullable

Whether the author moderates the community.

dataposts[]bannedFromCommunity
booleannullable

Whether the author is banned from the community.

Posts of the same link in other communities; null on list rows.

dataposts[]crossPosts[]id
integer

Post id on this instance.

dataposts[]crossPosts[]apId
stringnullable

Canonical ActivityPub id.

dataposts[]crossPosts[]title
stringnullable

Post title.

dataposts[]crossPosts[]url
stringnullable

Link the post points at; null for a text post.

dataposts[]crossPosts[]urlContentType
stringnullable

Content type of the link.

dataposts[]crossPosts[]thumbnailUrl
stringnullable

Thumbnail URL.

dataposts[]crossPosts[]nsfw
booleannullable

Whether the post is NSFW.

dataposts[]crossPosts[]locked
booleannullable

Whether the post is locked.

dataposts[]crossPosts[]removed
booleannullable

Whether a moderator removed it.

dataposts[]crossPosts[]deleted
booleannullable

Whether it was deleted.

dataposts[]crossPosts[]publishedAt
stringnullable

When it was posted.

dataposts[]crossPosts[]updatedAt
stringnullable

When it last changed.

dataposts[]crossPosts[]languageId
integernullable

Discussion language id.

dataposts[]crossPosts[]isLocal
booleannullable

Whether it was posted on the instance asked.

dataposts[]crossPosts[]score
integernullable

Votes up minus votes down.

dataposts[]crossPosts[]upvotes
integernullable

Upvotes.

dataposts[]crossPosts[]downvotes
integernullable

Downvotes.

dataposts[]crossPosts[]commentCount
integernullable

Comments on the post.

The community it was posted in.

dataposts[]crossPosts[]communityid
integer

Community id on this instance.

dataposts[]crossPosts[]communityname
string

Community name without the host.

dataposts[]crossPosts[]communitytitle
stringnullable

Display title.

dataposts[]crossPosts[]communityactorId
stringnullable

Canonical ActivityPub id.

dataposts[]crossPosts[]communityhost
stringnullable

Host the community lives on.

dataposts[]crossPosts[]communityhandle
stringnullable

`name@host`.

dataposts[]crossPosts[]communityicon
stringnullable

Community icon URL.

dataposts[]crossPosts[]communitynsfw
booleannullable

Whether the community is NSFW.

dataposts[]crossPosts[]communityisLocal
booleannullable

Whether the community lives on the instance asked.

Who posted it; null on a modlog row, which does not carry the creator.

dataposts[]crossPosts[]authorid
integer

User id on this instance.

dataposts[]crossPosts[]authorname
string

Username without the host.

dataposts[]crossPosts[]authordisplayName
stringnullable

Display name.

dataposts[]crossPosts[]authorbio
stringnullable

Profile text as Markdown.

dataposts[]crossPosts[]authoravatar
stringnullable

Avatar URL.

dataposts[]crossPosts[]authorbanner
stringnullable

Banner URL.

dataposts[]crossPosts[]authoractorId
stringnullable

Canonical ActivityPub id.

dataposts[]crossPosts[]authorhost
stringnullable

Host the account lives on.

dataposts[]crossPosts[]authorhandle
stringnullable

`user@host`.

dataposts[]crossPosts[]authorpublishedAt
stringnullable

When the account was created.

dataposts[]crossPosts[]authorupdatedAt
stringnullable

When the profile last changed.

dataposts[]crossPosts[]authorbanned
booleannullable

Whether the account is banned.

dataposts[]crossPosts[]authorbanExpiresAt
stringnullable

When the ban ends.

dataposts[]crossPosts[]authordeleted
booleannullable

Whether the account was deleted.

dataposts[]crossPosts[]authorisBot
booleannullable

Whether the account is a bot.

dataposts[]crossPosts[]authorisLocal
booleannullable

Whether the account lives on the instance asked.

dataposts[]crossPosts[]authormatrixUserId
stringnullable

Matrix id the user chose to publish.

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

dataposts[]moderators[]id
integer

User id on this instance.

dataposts[]moderators[]name
string

Username without the host.

dataposts[]moderators[]displayName
stringnullable

Display name.

dataposts[]moderators[]bio
stringnullable

Profile text as Markdown.

dataposts[]moderators[]avatar
stringnullable

Avatar URL.

dataposts[]moderators[]banner
stringnullable

Banner URL.

dataposts[]moderators[]actorId
stringnullable

Canonical ActivityPub id.

dataposts[]moderators[]host
stringnullable

Host the account lives on.

dataposts[]moderators[]handle
stringnullable

`user@host`.

dataposts[]moderators[]publishedAt
stringnullable

When the account was created.

dataposts[]moderators[]updatedAt
stringnullable

When the profile last changed.

dataposts[]moderators[]banned
booleannullable

Whether the account is banned.

dataposts[]moderators[]banExpiresAt
stringnullable

When the ban ends.

dataposts[]moderators[]deleted
booleannullable

Whether the account was deleted.

dataposts[]moderators[]isBot
booleannullable

Whether the account is a bot.

dataposts[]moderators[]isLocal
booleannullable

Whether the account lives on the instance asked.

dataposts[]moderators[]matrixUserId
stringnullable

Matrix id the user chose to publish.

The newest comment, from the user lookup. Use the user comments endpoint for more.

datacomments[]id
integer

Comment id on this instance.

datacomments[]apId
stringnullable

Canonical ActivityPub id.

datacomments[]content
stringnullable

Comment text as Markdown; empty when a moderator removed it or its author deleted it.

datacomments[]postId
integernullable

The post it belongs to.

datacomments[]path
stringnullable

The dotted ancestor chain, from the root post (`0.1234.5678`).

datacomments[]depth
integernullable

Depth in the tree, from `path`.

datacomments[]parentId
integernullable

The comment it replies to; null for a top-level comment.

datacomments[]distinguished
booleannullable

Whether a moderator marked it as a moderator comment.

datacomments[]languageId
integernullable

Discussion language id.

datacomments[]isLocal
booleannullable

Whether it was written on the instance asked.

datacomments[]removed
booleannullable

Whether a moderator removed it.

datacomments[]deleted
booleannullable

Whether its author deleted it.

datacomments[]publishedAt
stringnullable

When it was written.

datacomments[]updatedAt
stringnullable

When it last changed.

datacomments[]score
integernullable

Votes up minus votes down.

datacomments[]upvotes
integernullable

Upvotes.

datacomments[]downvotes
integernullable

Downvotes.

datacomments[]replyCount
integernullable

Direct replies.

datacomments[]isAdmin
booleannullable

Whether the author is an instance administrator.

datacomments[]isModerator
booleannullable

Whether the author moderates the community.

datacomments[]bannedFromCommunity
booleannullable

Whether the author is banned from the community.

The post it belongs to.

datacomments[]postid
integer

Post id on this instance.

datacomments[]postapId
stringnullable

Canonical ActivityPub id.

datacomments[]posttitle
stringnullable

Post title.

datacomments[]posturl
stringnullable

Link the post points at; null for a text post.

datacomments[]posturlContentType
stringnullable

Content type of the link.

datacomments[]postthumbnailUrl
stringnullable

Thumbnail URL.

datacomments[]postnsfw
booleannullable

Whether the post is NSFW.

datacomments[]postlocked
booleannullable

Whether the post is locked.

datacomments[]postremoved
booleannullable

Whether a moderator removed it.

datacomments[]postdeleted
booleannullable

Whether it was deleted.

datacomments[]postpublishedAt
stringnullable

When it was posted.

datacomments[]postupdatedAt
stringnullable

When it last changed.

datacomments[]postlanguageId
integernullable

Discussion language id.

datacomments[]postisLocal
booleannullable

Whether it was posted on the instance asked.

datacomments[]postscore
integernullable

Votes up minus votes down.

datacomments[]postupvotes
integernullable

Upvotes.

datacomments[]postdownvotes
integernullable

Downvotes.

datacomments[]postcommentCount
integernullable

Comments on the post.

The community it was posted in.

datacomments[]postcommunityid
integer

Community id on this instance.

datacomments[]postcommunityname
string

Community name without the host.

datacomments[]postcommunitytitle
stringnullable

Display title.

datacomments[]postcommunityactorId
stringnullable

Canonical ActivityPub id.

datacomments[]postcommunityhost
stringnullable

Host the community lives on.

datacomments[]postcommunityhandle
stringnullable

`name@host`.

datacomments[]postcommunityicon
stringnullable

Community icon URL.

datacomments[]postcommunitynsfw
booleannullable

Whether the community is NSFW.

datacomments[]postcommunityisLocal
booleannullable

Whether the community lives on the instance asked.

Who posted it; null on a modlog row, which does not carry the creator.

datacomments[]postauthorid
integer

User id on this instance.

datacomments[]postauthorname
string

Username without the host.

datacomments[]postauthordisplayName
stringnullable

Display name.

datacomments[]postauthorbio
stringnullable

Profile text as Markdown.

datacomments[]postauthoravatar
stringnullable

Avatar URL.

datacomments[]postauthorbanner
stringnullable

Banner URL.

datacomments[]postauthoractorId
stringnullable

Canonical ActivityPub id.

datacomments[]postauthorhost
stringnullable

Host the account lives on.

datacomments[]postauthorhandle
stringnullable

`user@host`.

datacomments[]postauthorpublishedAt
stringnullable

When the account was created.

datacomments[]postauthorupdatedAt
stringnullable

When the profile last changed.

datacomments[]postauthorbanned
booleannullable

Whether the account is banned.

datacomments[]postauthorbanExpiresAt
stringnullable

When the ban ends.

datacomments[]postauthordeleted
booleannullable

Whether the account was deleted.

datacomments[]postauthorisBot
booleannullable

Whether the account is a bot.

datacomments[]postauthorisLocal
booleannullable

Whether the account lives on the instance asked.

datacomments[]postauthormatrixUserId
stringnullable

Matrix id the user chose to publish.

The community of the post.

datacomments[]communityid
integer

Community id on this instance.

datacomments[]communityname
string

Community name without the host.

datacomments[]communitytitle
stringnullable

Display title.

datacomments[]communityactorId
stringnullable

Canonical ActivityPub id.

datacomments[]communityhost
stringnullable

Host the community lives on.

datacomments[]communityhandle
stringnullable

`name@host`.

datacomments[]communityicon
stringnullable

Community icon URL.

datacomments[]communitynsfw
booleannullable

Whether the community is NSFW.

datacomments[]communityisLocal
booleannullable

Whether the community lives on the instance asked.

Who wrote it.

datacomments[]authorid
integer

User id on this instance.

datacomments[]authorname
string

Username without the host.

datacomments[]authordisplayName
stringnullable

Display name.

datacomments[]authorbio
stringnullable

Profile text as Markdown.

datacomments[]authoravatar
stringnullable

Avatar URL.

datacomments[]authorbanner
stringnullable

Banner URL.

datacomments[]authoractorId
stringnullable

Canonical ActivityPub id.

datacomments[]authorhost
stringnullable

Host the account lives on.

datacomments[]authorhandle
stringnullable

`user@host`.

datacomments[]authorpublishedAt
stringnullable

When the account was created.

datacomments[]authorupdatedAt
stringnullable

When the profile last changed.

datacomments[]authorbanned
booleannullable

Whether the account is banned.

datacomments[]authorbanExpiresAt
stringnullable

When the ban ends.

datacomments[]authordeleted
booleannullable

Whether the account was deleted.

datacomments[]authorisBot
booleannullable

Whether the account is a bot.

datacomments[]authorisLocal
booleannullable

Whether the account lives on the instance asked.

datacomments[]authormatrixUserId
stringnullable

Matrix id the user chose to publish.

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/user?instance=lemmy.world&username=dessalines@lemmy.ml" \
  -H "x-api-key: YOUR_API_KEY"

Responses

User.