Skip to contents

Get the details for a person.

Source: R/http-methods.R
lemmy_get_person_details.Rd

HTTP.GET /user

Usage

lemmy_get_person_details(
  person_id = NULL,
  username = NULL,
  sort = NULL,
  page = NULL,
  limit = NULL,
  community_id = NULL,
  saved_only = NULL,
  auth = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

person_id

(Optional) A numeric value.

username

(Optional) A character value.

sort

(Optional) One of "Active", "Hot", "New", "Old", "TopDay", "TopWeek", "TopMonth", "TopYear", "TopAll", "MostComments", "NewComments", "TopHour", "TopSixHour", "TopTwelveHour", "TopThreeMonths", "TopSixMonths", or "TopNineMonths".

page

(Optional) A numeric value.

limit

(Optional) A numeric value.

community_id

(Optional) A numeric value.

saved_only

(Optional) A logical value.

auth

(Optional) A character value.

.lemmy_instance

Default: "https://lemmy.world". Change the default instance by setting the lemmy_instance options().

Value

A list of length 4:

<list>
|-person_view: <list>
| |-person: <list>
| | |-id: A numeric value
| | |-name: A character value
| | |-display_name: (Optional) A character value
| | |-avatar: (Optional) A character value
| | |-banned: A logical value
| | |-published: A character value
| | |-updated: (Optional) A character value
| | |-actor_id: A character value
| | |-bio: (Optional) A character value
| | |-local: A logical value
| | |-banner: (Optional) A character value
| | |-deleted: A logical value
| | |-inbox_url: A character value
| | |-matrix_user_id: (Optional) A character value
| | |-admin: A logical value
| | |-bot_account: A logical value
| | |-ban_expires: (Optional) A character value
| | `-instance_id: A numeric value
| `-counts: <list>
|   |-id: A numeric value
|   |-person_id: A numeric value
|   |-post_count: A numeric value
|   |-post_score: A numeric value
|   |-comment_count: A numeric value
|   `-comment_score: A numeric value
|-comments: <list>
| `-[Each element]: <list>
|   |-comment: <list>
|   | |-id: A numeric value
|   | |-creator_id: A numeric value
|   | |-post_id: A numeric value
|   | |-content: A character value
|   | |-removed: A logical value
|   | |-published: A character value
|   | |-updated: (Optional) A character value
|   | |-deleted: A logical value
|   | |-ap_id: A character value
|   | |-local: A logical value
|   | |-path: A character value
|   | |-distinguished: A logical value
|   | `-language_id: A numeric value
|   |-creator: <list>
|   | |-id: A numeric value
|   | |-name: A character value
|   | |-display_name: (Optional) A character value
|   | |-avatar: (Optional) A character value
|   | |-banned: A logical value
|   | |-published: A character value
|   | |-updated: (Optional) A character value
|   | |-actor_id: A character value
|   | |-bio: (Optional) A character value
|   | |-local: A logical value
|   | |-banner: (Optional) A character value
|   | |-deleted: A logical value
|   | |-inbox_url: A character value
|   | |-matrix_user_id: (Optional) A character value
|   | |-admin: A logical value
|   | |-bot_account: A logical value
|   | |-ban_expires: (Optional) A character value
|   | `-instance_id: A numeric value
|   |-post: <list>
|   | |-id: A numeric value
|   | |-name: A character value
|   | |-url: (Optional) A character value
|   | |-body: (Optional) A character value
|   | |-creator_id: A numeric value
|   | |-community_id: A numeric value
|   | |-removed: A logical value
|   | |-locked: A logical value
|   | |-published: A character value
|   | |-updated: (Optional) A character value
|   | |-deleted: A logical value
|   | |-nsfw: A logical value
|   | |-embed_title: (Optional) A character value
|   | |-embed_description: (Optional) A character value
|   | |-thumbnail_url: (Optional) A character value
|   | |-ap_id: A character value
|   | |-local: A logical value
|   | |-embed_video_url: (Optional) A character value
|   | |-language_id: A numeric value
|   | |-featured_community: A logical value
|   | `-featured_local: A logical value
|   |-community: <list>
|   | |-id: A numeric value
|   | |-name: A character value
|   | |-title: A character value
|   | |-description: (Optional) A character value
|   | |-removed: A logical value
|   | |-published: A character value
|   | |-updated: (Optional) A character value
|   | |-deleted: A logical value
|   | |-nsfw: A logical value
|   | |-actor_id: A character value
|   | |-local: A logical value
|   | |-icon: (Optional) A character value
|   | |-banner: (Optional) A character value
|   | |-followers_url: A character value
|   | |-inbox_url: A character value
|   | |-hidden: A logical value
|   | |-posting_restricted_to_mods: A logical value
|   | `-instance_id: A numeric value
|   |-counts: <list>
|   | |-id: A numeric value
|   | |-comment_id: A numeric value
|   | |-score: A numeric value
|   | |-upvotes: A numeric value
|   | |-downvotes: A numeric value
|   | |-published: A character value
|   | |-child_count: A numeric value
|   | `-hot_rank: A numeric value
|   |-creator_banned_from_community: A logical value
|   |-subscribed: One of "Subscribed", "NotSubscri...
|   |-saved: A logical value
|   |-creator_blocked: A logical value
|   `-my_vote: (Optional) A numeric value
|-posts: <list>
| `-[Each element]: <list>
|   |-post: <list>
|   | |-id: A numeric value
|   | |-name: A character value
|   | |-url: (Optional) A character value
|   | |-body: (Optional) A character value
|   | |-creator_id: A numeric value
|   | |-community_id: A numeric value
|   | |-removed: A logical value
|   | |-locked: A logical value
|   | |-published: A character value
|   | |-updated: (Optional) A character value
|   | |-deleted: A logical value
|   | |-nsfw: A logical value
|   | |-embed_title: (Optional) A character value
|   | |-embed_description: (Optional) A character value
|   | |-thumbnail_url: (Optional) A character value
|   | |-ap_id: A character value
|   | |-local: A logical value
|   | |-embed_video_url: (Optional) A character value
|   | |-language_id: A numeric value
|   | |-featured_community: A logical value
|   | `-featured_local: A logical value
|   |-creator: <list>
|   | |-id: A numeric value
|   | |-name: A character value
|   | |-display_name: (Optional) A character value
|   | |-avatar: (Optional) A character value
|   | |-banned: A logical value
|   | |-published: A character value
|   | |-updated: (Optional) A character value
|   | |-actor_id: A character value
|   | |-bio: (Optional) A character value
|   | |-local: A logical value
|   | |-banner: (Optional) A character value
|   | |-deleted: A logical value
|   | |-inbox_url: A character value
|   | |-matrix_user_id: (Optional) A character value
|   | |-admin: A logical value
|   | |-bot_account: A logical value
|   | |-ban_expires: (Optional) A character value
|   | `-instance_id: A numeric value
|   |-community: <list>
|   | |-id: A numeric value
|   | |-name: A character value
|   | |-title: A character value
|   | |-description: (Optional) A character value
|   | |-removed: A logical value
|   | |-published: A character value
|   | |-updated: (Optional) A character value
|   | |-deleted: A logical value
|   | |-nsfw: A logical value
|   | |-actor_id: A character value
|   | |-local: A logical value
|   | |-icon: (Optional) A character value
|   | |-banner: (Optional) A character value
|   | |-followers_url: A character value
|   | |-inbox_url: A character value
|   | |-hidden: A logical value
|   | |-posting_restricted_to_mods: A logical value
|   | `-instance_id: A numeric value
|   |-creator_banned_from_community: A logical value
|   |-counts: <list>
|   | |-id: A numeric value
|   | |-post_id: A numeric value
|   | |-comments: A numeric value
|   | |-score: A numeric value
|   | |-upvotes: A numeric value
|   | |-downvotes: A numeric value
|   | |-published: A character value
|   | |-newest_comment_time_necro: A character value
|   | |-newest_comment_time: A character value
|   | |-featured_community: A logical value
|   | |-featured_local: A logical value
|   | |-hot_rank: A numeric value
|   | `-hot_rank_active: A numeric value
|   |-subscribed: One of "Subscribed", "NotSubscri...
|   |-saved: A logical value
|   |-read: A logical value
|   |-creator_blocked: A logical value
|   |-my_vote: (Optional) A numeric value
|   `-unread_comments: A numeric value
`-moderates: <list>
  `-[Each element]: <list>
    |-community: <list>
    | |-id: A numeric value
    | |-name: A character value
    | |-title: A character value
    | |-description: (Optional) A character value
    | |-removed: A logical value
    | |-published: A character value
    | |-updated: (Optional) A character value
    | |-deleted: A logical value
    | |-nsfw: A logical value
    | |-actor_id: A character value
    | |-local: A logical value
    | |-icon: (Optional) A character value
    | |-banner: (Optional) A character value
    | |-followers_url: A character value
    | |-inbox_url: A character value
    | |-hidden: A logical value
    | |-posting_restricted_to_mods: A logical value
    | `-instance_id: A numeric value
    `-moderator: <list>
      |-id: A numeric value
      |-name: A character value
      |-display_name: (Optional) A character value
      |-avatar: (Optional) A character value
      |-banned: A logical value
      |-published: A character value
      |-updated: (Optional) A character value
      |-actor_id: A character value
      |-bio: (Optional) A character value
      |-local: A logical value
      |-banner: (Optional) A character value
      |-deleted: A logical value
      |-inbox_url: A character value
      |-matrix_user_id: (Optional) A character value
      |-admin: A logical value
      |-bot_account: A logical value
      |-ban_expires: (Optional) A character value
      `-instance_id: A numeric value

Examples

person_data <- lemmy_get_person_details(username = "ruud")

person_data$person_view$person$bio
#> [1] "Admin of a lot of fediverse servers, among which the .world ones:\n- lemmy.world\n- mastodon.world\n- calckey.world\n\nYou can find me on these servers as @ruud\n\nI receive a lot of messages, direct and mentions. I can't reply to them all.\nIf you have an issue, please e-mail at info@lemmy.world"

sapply(person_data$moderates, function(x) x$community$name)
#>  [1] "fediverse"            "music"                "lemmyworld"          
#>  [4] "mastodon"             "selfhosted"           "allaboutfantasymedia"
#>  [7] "nederlands"           "lemmyworldtest"       "ruudtipsmusic"       
#> [10] "support"              "moderators"           "nltop40"             
#> [13] "psv"