Package 'remmy'

Title:	API Client for 'Lemmy'
Description:	An HTTP API client for 'Lemmy' (<https://github.com/LemmyNet/lemmy>) in R. Code and documentation are generated from the official 'JavaScript' client source (<https://github.com/LemmyNet/lemmy-js-client>).
Authors:	Long Nguyen [aut, cre] (ORCID: <https://orcid.org/0000-0001-8878-7386>)
Maintainer:	Long Nguyen <[email protected]>
License:	MIT + file LICENSE
Version:	0.1.0
Built:	2026-05-15 06:18:50 UTC
Source:	https://github.com/long39ng/remmy

Help Index

Add an admin to your site.
Add a moderator to your community.
Approve a registration application
Ban a user from a community.
Ban a person from your site.
Block a community.
Block a person.
Change your user password.
Create a comment.
Report a comment.
Create a new community.
Create a new custom emoji
Create a post.
Report a post.
Create a private message.
Create a report for a private message.
Create your site.
Delete your account.
Delete a comment.
Delete a community.
Delete a custom emoji
Delete a post.
Delete a private message.
Distinguishes a comment (speak as moderator)
Edit a comment.
Edit a community.
Edit an existing custom emoji
Edit a post.
Edit a private message.
Edit your site.
A moderator can feature a community post ( IE stick it to the top of a community ).
Follow / subscribe to a community.
Get a list of banned users
Fetch a Captcha.
Get / fetch comment.
Get / fetch comments.
Get / fetch a community.
Fetch federated instances.
Get the modlog.
Get the details for a person.
Get mentions for your user.
Get / fetch a post.
Get / fetch posts, with various filters.
Get / fetch private messages.
Get comment replies.
Get counts for your reports
Gets the site, and your user data.
Fetch metadata for any given site.
Get your unread counts
Get the unread registration applications count.
Leave the Site admins.
Like / vote on a comment.
Like / vote on a post.
List comment reports.
List communities, with various filters.
List post reports.
List private message reports.
List the registration applications.
A moderator can lock a post ( IE disable new comments ).
Log into lemmy.
Mark all replies as read.
Mark a comment as read.
Mark a person mention as read.
Mark a post as read.
Mark a private message as read.
Change your password from an email / token based reset.
Reset your password.
Purge / Delete a comment from the database.
Purge / Delete a community from the database.
Purge / Delete a person from the database.
Purge / Delete a post from the database.
Register a new user.
A moderator remove for a comment.
A moderator remove for a community.
A moderator remove for a post.
Resolve a comment report. Only a mod can do this.
Fetch a non-local / federated object.
Resolve a post report. Only a mod can do this.
Resolve a report for a private message.
Save a comment.
Save a post.
Save your user settings.
Search lemmy.
Transfer your community to an existing moderator.
Verify your email

Add an admin to your site.

Description

HTTP.POST /admin/add

Usage

lemmy_add_admin(
  person_id,
  added,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_add_admin(
  person_id,
  added,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

person_id

A numeric value.

added

A logical value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-admins: <list>
  `-[Each element]: <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

Add a moderator to your community.

Description

HTTP.POST /community/mod

Usage

lemmy_add_mod_to_community(
  community_id,
  person_id,
  added,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_add_mod_to_community(
  community_id,
  person_id,
  added,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

community_id

A numeric value.

person_id

A numeric value.

added

A logical value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-moderators: <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

Approve a registration application

Description

HTTP.PUT /admin/registration_application/approve

Usage

lemmy_approve_registration_application(
  id,
  approve,
  deny_reason = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_approve_registration_application(
  id,
  approve,
  deny_reason = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

id

A numeric value.

approve

A logical value.

deny_reason

(Optional) A character value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-registration_application: <list>
  |-registration_application: <list>
  | |-id: A numeric value
  | |-local_user_id: A numeric value
  | |-answer: A character value
  | |-admin_id: (Optional) A numeric value
  | |-deny_reason: (Optional) A character value
  | `-published: A character value
  |-creator_local_user: <list>
  | |-id: A numeric value
  | |-person_id: A numeric value
  | |-email: (Optional) A character value
  | |-show_nsfw: A logical value
  | |-theme: A character value
  | |-default_sort_type: One of "Active", "Hot", "New", "...
  | |-default_listing_type: One of "All", "Local", or "Subsc...
  | |-interface_language: A character value
  | |-show_avatars: A logical value
  | |-send_notifications_to_email: A logical value
  | |-validator_time: A character value
  | |-show_scores: A logical value
  | |-show_bot_accounts: A logical value
  | |-show_read_posts: A logical value
  | |-show_new_post_notifs: A logical value
  | |-email_verified: A logical value
  | |-accepted_application: A logical value
  | |-totp_2fa_url: (Optional) A character value
  | `-open_links_in_new_tab: 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
  `-admin: <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

Ban a user from a community.

Description

HTTP.POST /community/ban_user

Usage

lemmy_ban_from_community(
  community_id,
  person_id,
  ban,
  remove_data = NULL,
  reason = NULL,
  expires = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_ban_from_community(
  community_id,
  person_id,
  ban,
  remove_data = NULL,
  reason = NULL,
  expires = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

community_id

A numeric value.

person_id

A numeric value.

ban

A logical value.

remove_data

(Optional) A logical value.

reason

(Optional) A character value.

expires

(Optional) A numeric value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 2:

<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
`-banned: A logical value

Ban a person from your site.

Description

HTTP.POST /user/ban

Usage

lemmy_ban_person(
  person_id,
  ban,
  remove_data = NULL,
  reason = NULL,
  expires = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_ban_person(
  person_id,
  ban,
  remove_data = NULL,
  reason = NULL,
  expires = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

person_id

A numeric value.

ban

A logical value.

remove_data

(Optional) A logical value.

reason

(Optional) A character value.

expires

(Optional) A numeric value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 2:

<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
`-banned: A logical value

Block a community.

Description

HTTP.POST /community/block

Usage

lemmy_block_community(
  community_id,
  block,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_block_community(
  community_id,
  block,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

community_id

A numeric value.

block

A logical value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 2:

<list>
|-community_view: <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
| |-subscribed: One of "Subscribed", "NotSubscri...
| |-blocked: A logical value
| `-counts: <list>
|   |-id: A numeric value
|   |-community_id: A numeric value
|   |-subscribers: A numeric value
|   |-posts: A numeric value
|   |-comments: A numeric value
|   |-published: A character value
|   |-users_active_day: A numeric value
|   |-users_active_week: A numeric value
|   |-users_active_month: A numeric value
|   |-users_active_half_year: A numeric value
|   `-hot_rank: A numeric value
`-blocked: A logical value

Block a person.

Description

HTTP.POST /user/block

Usage

lemmy_block_person(
  person_id,
  block,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_block_person(
  person_id,
  block,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

person_id

A numeric value.

block

A logical value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 2:

<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
`-blocked: A logical value

Change your user password.

Description

HTTP.PUT /user/change_password

Usage

lemmy_change_password(
  new_password,
  new_password_verify,
  old_password,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_change_password(
  new_password,
  new_password_verify,
  old_password,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

new_password

A character value.

new_password_verify

A character value.

old_password

A character value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 3:

<list>
|-jwt: (Optional) A character value
|-registration_created: A logical value
`-verify_email_sent: A logical value

Create a comment.

Description

HTTP.POST /comment

Usage

lemmy_create_comment(
  content,
  post_id,
  parent_id = NULL,
  language_id = NULL,
  form_id = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_create_comment(
  content,
  post_id,
  parent_id = NULL,
  language_id = NULL,
  form_id = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

content

A character value.

post_id

A numeric value.

parent_id

(Optional) A numeric value.

language_id

(Optional) A numeric value.

form_id

(Optional) A character value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 3:

<list>
|-comment_view: <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
|-recipient_ids: A numeric vector
`-form_id: (Optional) A character value

Report a comment.

Description

HTTP.POST /comment/report

Usage

lemmy_create_comment_report(
  comment_id,
  reason,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_create_comment_report(
  comment_id,
  reason,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

comment_id

A numeric value.

reason

A character value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-comment_report_view: <list>
  |-comment_report: <list>
  | |-id: A numeric value
  | |-creator_id: A numeric value
  | |-comment_id: A numeric value
  | |-original_comment_text: A character value
  | |-reason: A character value
  | |-resolved: A logical value
  | |-resolver_id: (Optional) A numeric value
  | |-published: A character value
  | `-updated: (Optional) A character value
  |-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
  |-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
  |-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
  |-comment_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
  |-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
  |-my_vote: (Optional) A numeric value
  `-resolver: <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

Create a new community.

Description

HTTP.POST /community

Usage

lemmy_create_community(
  name,
  title,
  description = NULL,
  icon = NULL,
  banner = NULL,
  nsfw = NULL,
  posting_restricted_to_mods = NULL,
  discussion_languages = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_create_community(
  name,
  title,
  description = NULL,
  icon = NULL,
  banner = NULL,
  nsfw = NULL,
  posting_restricted_to_mods = NULL,
  discussion_languages = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

name

A character value.

title

A character value.

description

(Optional) A character value.

icon

(Optional) A character value.

nsfw

(Optional) A logical value.

posting_restricted_to_mods

(Optional) A logical value.

discussion_languages

(Optional) A numeric vector.

auth

A character value.

.lemmy_instance

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

Value

A list of length 2:

<list>
|-community_view: <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
| |-subscribed: One of "Subscribed", "NotSubscri...
| |-blocked: A logical value
| `-counts: <list>
|   |-id: A numeric value
|   |-community_id: A numeric value
|   |-subscribers: A numeric value
|   |-posts: A numeric value
|   |-comments: A numeric value
|   |-published: A character value
|   |-users_active_day: A numeric value
|   |-users_active_week: A numeric value
|   |-users_active_month: A numeric value
|   |-users_active_half_year: A numeric value
|   `-hot_rank: A numeric value
`-discussion_languages: A numeric vector

Create a new custom emoji

Description

HTTP.POST /custom_emoji

Usage

lemmy_create_custom_emoji(
  category,
  shortcode,
  image_url,
  alt_text,
  keywords,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_create_custom_emoji(
  category,
  shortcode,
  image_url,
  alt_text,
  keywords,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

category

A character value.

shortcode

A character value.

image_url

A character value.

alt_text

A character value.

keywords

A character vector.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-custom_emoji: <list>
  |-custom_emoji: <list>
  | |-id: A numeric value
  | |-local_site_id: A numeric value
  | |-shortcode: A character value
  | |-image_url: A character value
  | |-alt_text: A character value
  | |-category: A character value
  | |-published: A character value
  | `-updated: (Optional) A character value
  `-keywords: <list>
    `-[Each element]: <list>
      |-id: A numeric value
      |-custom_emoji_id: A numeric value
      `-keyword: A character value

Create a post.

Description

HTTP.POST /post

Usage

lemmy_create_post(
  name,
  community_id,
  url = NULL,
  body = NULL,
  honeypot = NULL,
  nsfw = NULL,
  language_id = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_create_post(
  name,
  community_id,
  url = NULL,
  body = NULL,
  honeypot = NULL,
  nsfw = NULL,
  language_id = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

name

A character value.

community_id

A numeric value.

url

(Optional) A character value.

body

(Optional) A character value.

honeypot

(Optional) A character value.

nsfw

(Optional) A logical value.

language_id

(Optional) A numeric value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-post_view: <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

Report a post.

Description

HTTP.POST /post/report

Usage

lemmy_create_post_report(
  post_id,
  reason,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_create_post_report(
  post_id,
  reason,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

post_id

A numeric value.

reason

A character value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-post_report_view: <list>
  |-post_report: <list>
  | |-id: A numeric value
  | |-creator_id: A numeric value
  | |-post_id: A numeric value
  | |-original_post_name: A character value
  | |-original_post_url: (Optional) A character value
  | |-original_post_body: (Optional) A character value
  | |-reason: A character value
  | |-resolved: A logical value
  | |-resolver_id: (Optional) A numeric value
  | |-published: A character value
  | `-updated: (Optional) A character 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
  |-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_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
  |-creator_banned_from_community: A logical value
  |-my_vote: (Optional) A numeric 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
  `-resolver: <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

Create a private message.

Description

HTTP.POST /private_message

Usage

lemmy_create_private_message(
  content,
  recipient_id,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_create_private_message(
  content,
  recipient_id,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

content

A character value.

recipient_id

A numeric value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-private_message_view: <list>
  |-private_message: <list>
  | |-id: A numeric value
  | |-creator_id: A numeric value
  | |-recipient_id: A numeric value
  | |-content: A character value
  | |-deleted: A logical value
  | |-read: A logical value
  | |-published: A character value
  | |-updated: (Optional) A character value
  | |-ap_id: A character value
  | `-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
  `-recipient: <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

Create a report for a private message.

Description

HTTP.POST /private_message/report

Usage

lemmy_create_private_message_report(
  private_message_id,
  reason,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_create_private_message_report(
  private_message_id,
  reason,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

private_message_id

A numeric value.

reason

A character value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-private_message_report_view: <list>
  |-private_message_report: <list>
  | |-id: A numeric value
  | |-creator_id: A numeric value
  | |-private_message_id: A numeric value
  | |-original_pm_text: A character value
  | |-reason: A character value
  | |-resolved: A logical value
  | |-resolver_id: (Optional) A numeric value
  | |-published: A character value
  | `-updated: (Optional) A character value
  |-private_message: <list>
  | |-id: A numeric value
  | |-creator_id: A numeric value
  | |-recipient_id: A numeric value
  | |-content: A character value
  | |-deleted: A logical value
  | |-read: A logical value
  | |-published: A character value
  | |-updated: (Optional) A character value
  | |-ap_id: A character value
  | `-local: A logical value
  |-private_message_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
  |-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
  `-resolver: <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

Create your site.

Description

HTTP.POST /site

Usage

lemmy_create_site(
  name,
  sidebar = NULL,
  description = NULL,
  icon = NULL,
  banner = NULL,
  enable_downvotes = NULL,
  enable_nsfw = NULL,
  community_creation_admin_only = NULL,
  require_email_verification = NULL,
  application_question = NULL,
  private_instance = NULL,
  default_theme = NULL,
  default_post_listing_type = NULL,
  legal_information = NULL,
  application_email_admins = NULL,
  hide_modlog_mod_names = NULL,
  discussion_languages = NULL,
  slur_filter_regex = NULL,
  actor_name_max_length = NULL,
  rate_limit_message = NULL,
  rate_limit_message_per_second = NULL,
  rate_limit_post = NULL,
  rate_limit_post_per_second = NULL,
  rate_limit_register = NULL,
  rate_limit_register_per_second = NULL,
  rate_limit_image = NULL,
  rate_limit_image_per_second = NULL,
  rate_limit_comment = NULL,
  rate_limit_comment_per_second = NULL,
  rate_limit_search = NULL,
  rate_limit_search_per_second = NULL,
  federation_enabled = NULL,
  federation_debug = NULL,
  captcha_enabled = NULL,
  captcha_difficulty = NULL,
  allowed_instances = NULL,
  blocked_instances = NULL,
  taglines = NULL,
  registration_mode = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_create_site(
  name,
  sidebar = NULL,
  description = NULL,
  icon = NULL,
  banner = NULL,
  enable_downvotes = NULL,
  enable_nsfw = NULL,
  community_creation_admin_only = NULL,
  require_email_verification = NULL,
  application_question = NULL,
  private_instance = NULL,
  default_theme = NULL,
  default_post_listing_type = NULL,
  legal_information = NULL,
  application_email_admins = NULL,
  hide_modlog_mod_names = NULL,
  discussion_languages = NULL,
  slur_filter_regex = NULL,
  actor_name_max_length = NULL,
  rate_limit_message = NULL,
  rate_limit_message_per_second = NULL,
  rate_limit_post = NULL,
  rate_limit_post_per_second = NULL,
  rate_limit_register = NULL,
  rate_limit_register_per_second = NULL,
  rate_limit_image = NULL,
  rate_limit_image_per_second = NULL,
  rate_limit_comment = NULL,
  rate_limit_comment_per_second = NULL,
  rate_limit_search = NULL,
  rate_limit_search_per_second = NULL,
  federation_enabled = NULL,
  federation_debug = NULL,
  captcha_enabled = NULL,
  captcha_difficulty = NULL,
  allowed_instances = NULL,
  blocked_instances = NULL,
  taglines = NULL,
  registration_mode = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

name

A character value.

(Optional) A character value.

description

(Optional) A character value.

icon

(Optional) A character value.

enable_downvotes

(Optional) A logical value.

enable_nsfw

(Optional) A logical value.

community_creation_admin_only

(Optional) A logical value.

require_email_verification

(Optional) A logical value.

application_question

(Optional) A character value.

private_instance

(Optional) A logical value.

default_theme

(Optional) A character value.

default_post_listing_type

(Optional) One of "All", "Local", or "Subscribed".

legal_information

(Optional) A character value.

application_email_admins

(Optional) A logical value.

hide_modlog_mod_names

(Optional) A logical value.

discussion_languages

(Optional) A numeric vector.

slur_filter_regex

(Optional) A character value.

actor_name_max_length

(Optional) A numeric value.

rate_limit_message

(Optional) A numeric value.

rate_limit_message_per_second

(Optional) A numeric value.

rate_limit_post

(Optional) A numeric value.

rate_limit_post_per_second

(Optional) A numeric value.

rate_limit_register

(Optional) A numeric value.

rate_limit_register_per_second

(Optional) A numeric value.

rate_limit_image

(Optional) A numeric value.

rate_limit_image_per_second

(Optional) A numeric value.

rate_limit_comment

(Optional) A numeric value.

rate_limit_comment_per_second

(Optional) A numeric value.

rate_limit_search

(Optional) A numeric value.

rate_limit_search_per_second

(Optional) A numeric value.

federation_enabled

(Optional) A logical value.

federation_debug

(Optional) A logical value.

captcha_enabled

(Optional) A logical value.

captcha_difficulty

(Optional) A character value.

allowed_instances

(Optional) A character vector.

blocked_instances

(Optional) A character vector.

taglines

(Optional) A character vector.

registration_mode

(Optional) One of "Closed", "RequireApplication", or "Open".

auth

A character value.

.lemmy_instance

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

Value

A list of length 2:

<list>
|-site_view: <list>
| |-site: <list>
| | |-id: A numeric value
| | |-name: A character value
| | |-sidebar: (Optional) A character value
| | |-published: A character value
| | |-updated: (Optional) A character value
| | |-icon: (Optional) A character value
| | |-banner: (Optional) A character value
| | |-description: (Optional) A character value
| | |-actor_id: A character value
| | |-last_refreshed_at: A character value
| | |-inbox_url: A character value
| | |-private_key: (Optional) A character value
| | |-public_key: A character value
| | `-instance_id: A numeric value
| |-local_site: <list>
| | |-id: A numeric value
| | |-site_id: A numeric value
| | |-site_setup: A logical value
| | |-enable_downvotes: A logical value
| | |-enable_nsfw: A logical value
| | |-community_creation_admin_only: A logical value
| | |-require_email_verification: A logical value
| | |-application_question: (Optional) A character value
| | |-private_instance: A logical value
| | |-default_theme: A character value
| | |-default_post_listing_type: One of "All", "Local", or "Subsc...
| | |-legal_information: (Optional) A character value
| | |-hide_modlog_mod_names: A logical value
| | |-application_email_admins: A logical value
| | |-slur_filter_regex: (Optional) A character value
| | |-actor_name_max_length: A numeric value
| | |-federation_enabled: A logical value
| | |-captcha_enabled: A logical value
| | |-captcha_difficulty: A character value
| | |-published: A character value
| | |-updated: (Optional) A character value
| | |-registration_mode: One of "Closed", "RequireApplica...
| | `-reports_email_admins: A logical value
| |-local_site_rate_limit: <list>
| | |-id: A numeric value
| | |-local_site_id: A numeric value
| | |-message: A numeric value
| | |-message_per_second: A numeric value
| | |-post: A numeric value
| | |-post_per_second: A numeric value
| | |-register: A numeric value
| | |-register_per_second: A numeric value
| | |-image: A numeric value
| | |-image_per_second: A numeric value
| | |-comment: A numeric value
| | |-comment_per_second: A numeric value
| | |-search: A numeric value
| | |-search_per_second: A numeric value
| | |-published: A character value
| | `-updated: (Optional) A character value
| `-counts: <list>
|   |-id: A numeric value
|   |-site_id: A numeric value
|   |-users: A numeric value
|   |-posts: A numeric value
|   |-comments: A numeric value
|   |-communities: A numeric value
|   |-users_active_day: A numeric value
|   |-users_active_week: A numeric value
|   |-users_active_month: A numeric value
|   `-users_active_half_year: A numeric value
`-taglines: <list>
  `-[Each element]: <list>
    |-id: A numeric value
    |-local_site_id: A numeric value
    |-content: A character value
    |-published: A character value
    `-updated: (Optional) A character value

Delete your account.

Description

HTTP.POST /user/delete_account

Usage

lemmy_delete_account(
  password,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_delete_account(
  password,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

password

A character value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 0:

<list>

Delete a comment.

Description

HTTP.POST /comment/delete

Usage

lemmy_delete_comment(
  comment_id,
  deleted,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_delete_comment(
  comment_id,
  deleted,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

comment_id

A numeric value.

deleted

A logical value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 3:

<list>
|-comment_view: <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
|-recipient_ids: A numeric vector
`-form_id: (Optional) A character value

Delete a community.

Description

HTTP.POST /community/delete

Usage

lemmy_delete_community(
  community_id,
  deleted,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_delete_community(
  community_id,
  deleted,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

community_id

A numeric value.

deleted

A logical value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 2:

<list>
|-community_view: <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
| |-subscribed: One of "Subscribed", "NotSubscri...
| |-blocked: A logical value
| `-counts: <list>
|   |-id: A numeric value
|   |-community_id: A numeric value
|   |-subscribers: A numeric value
|   |-posts: A numeric value
|   |-comments: A numeric value
|   |-published: A character value
|   |-users_active_day: A numeric value
|   |-users_active_week: A numeric value
|   |-users_active_month: A numeric value
|   |-users_active_half_year: A numeric value
|   `-hot_rank: A numeric value
`-discussion_languages: A numeric vector

Delete a custom emoji

Description

HTTP.Post /custom_emoji/delete

Usage

lemmy_delete_custom_emoji(
  id,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_delete_custom_emoji(
  id,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

id

A numeric value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 2:

<list>
|-id: A numeric value
`-success: A logical value

Delete a post.

Description

HTTP.POST /post/delete

Usage

lemmy_delete_post(
  post_id,
  deleted,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_delete_post(
  post_id,
  deleted,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

post_id

A numeric value.

deleted

A logical value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-post_view: <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

Delete a private message.

Description

HTTP.POST /private_message/delete

Usage

lemmy_delete_private_message(
  private_message_id,
  deleted,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_delete_private_message(
  private_message_id,
  deleted,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

private_message_id

A numeric value.

deleted

A logical value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-private_message_view: <list>
  |-private_message: <list>
  | |-id: A numeric value
  | |-creator_id: A numeric value
  | |-recipient_id: A numeric value
  | |-content: A character value
  | |-deleted: A logical value
  | |-read: A logical value
  | |-published: A character value
  | |-updated: (Optional) A character value
  | |-ap_id: A character value
  | `-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
  `-recipient: <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

Distinguishes a comment (speak as moderator)

Description

HTTP.POST /comment/distinguish

Usage

lemmy_distinguish_comment(
  comment_id,
  distinguished,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_distinguish_comment(
  comment_id,
  distinguished,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

comment_id

A numeric value.

distinguished

A logical value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 3:

<list>
|-comment_view: <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
|-recipient_ids: A numeric vector
`-form_id: (Optional) A character value

Edit a comment.

Description

HTTP.PUT /comment

Usage

lemmy_edit_comment(
  comment_id,
  content = NULL,
  language_id = NULL,
  form_id = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_edit_comment(
  comment_id,
  content = NULL,
  language_id = NULL,
  form_id = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

comment_id

A numeric value.

content

(Optional) A character value.

language_id

(Optional) A numeric value.

form_id

(Optional) A character value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 3:

<list>
|-comment_view: <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
|-recipient_ids: A numeric vector
`-form_id: (Optional) A character value

Edit a community.

Description

HTTP.PUT /community

Usage

lemmy_edit_community(
  community_id,
  title = NULL,
  description = NULL,
  icon = NULL,
  banner = NULL,
  nsfw = NULL,
  posting_restricted_to_mods = NULL,
  discussion_languages = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_edit_community(
  community_id,
  title = NULL,
  description = NULL,
  icon = NULL,
  banner = NULL,
  nsfw = NULL,
  posting_restricted_to_mods = NULL,
  discussion_languages = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

community_id

A numeric value.

title

(Optional) A character value.

description

(Optional) A character value.

icon

(Optional) A character value.

nsfw

(Optional) A logical value.

posting_restricted_to_mods

(Optional) A logical value.

discussion_languages

(Optional) A numeric vector.

auth

A character value.

.lemmy_instance

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

Value

A list of length 2:

<list>
|-community_view: <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
| |-subscribed: One of "Subscribed", "NotSubscri...
| |-blocked: A logical value
| `-counts: <list>
|   |-id: A numeric value
|   |-community_id: A numeric value
|   |-subscribers: A numeric value
|   |-posts: A numeric value
|   |-comments: A numeric value
|   |-published: A character value
|   |-users_active_day: A numeric value
|   |-users_active_week: A numeric value
|   |-users_active_month: A numeric value
|   |-users_active_half_year: A numeric value
|   `-hot_rank: A numeric value
`-discussion_languages: A numeric vector

Edit an existing custom emoji

Description

HTTP.PUT /custom_emoji

Usage

lemmy_edit_custom_emoji(
  id,
  category,
  image_url,
  alt_text,
  keywords,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_edit_custom_emoji(
  id,
  category,
  image_url,
  alt_text,
  keywords,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

id

A numeric value.

category

A character value.

image_url

A character value.

alt_text

A character value.

keywords

A character vector.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-custom_emoji: <list>
  |-custom_emoji: <list>
  | |-id: A numeric value
  | |-local_site_id: A numeric value
  | |-shortcode: A character value
  | |-image_url: A character value
  | |-alt_text: A character value
  | |-category: A character value
  | |-published: A character value
  | `-updated: (Optional) A character value
  `-keywords: <list>
    `-[Each element]: <list>
      |-id: A numeric value
      |-custom_emoji_id: A numeric value
      `-keyword: A character value

Edit a post.

Description

HTTP.PUT /post

Usage

lemmy_edit_post(
  post_id,
  name = NULL,
  url = NULL,
  body = NULL,
  nsfw = NULL,
  language_id = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_edit_post(
  post_id,
  name = NULL,
  url = NULL,
  body = NULL,
  nsfw = NULL,
  language_id = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

post_id

A numeric value.

name

(Optional) A character value.

url

(Optional) A character value.

body

(Optional) A character value.

nsfw

(Optional) A logical value.

language_id

(Optional) A numeric value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-post_view: <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

Edit a private message.

Description

HTTP.PUT /private_message

Usage

lemmy_edit_private_message(
  private_message_id,
  content,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_edit_private_message(
  private_message_id,
  content,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

private_message_id

A numeric value.

content

A character value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-private_message_view: <list>
  |-private_message: <list>
  | |-id: A numeric value
  | |-creator_id: A numeric value
  | |-recipient_id: A numeric value
  | |-content: A character value
  | |-deleted: A logical value
  | |-read: A logical value
  | |-published: A character value
  | |-updated: (Optional) A character value
  | |-ap_id: A character value
  | `-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
  `-recipient: <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

Edit your site.

Description

HTTP.PUT /site

Usage

lemmy_edit_site(
  name = NULL,
  sidebar = NULL,
  description = NULL,
  icon = NULL,
  banner = NULL,
  enable_downvotes = NULL,
  enable_nsfw = NULL,
  community_creation_admin_only = NULL,
  require_email_verification = NULL,
  application_question = NULL,
  private_instance = NULL,
  default_theme = NULL,
  default_post_listing_type = NULL,
  legal_information = NULL,
  application_email_admins = NULL,
  hide_modlog_mod_names = NULL,
  discussion_languages = NULL,
  slur_filter_regex = NULL,
  actor_name_max_length = NULL,
  rate_limit_message = NULL,
  rate_limit_message_per_second = NULL,
  rate_limit_post = NULL,
  rate_limit_post_per_second = NULL,
  rate_limit_register = NULL,
  rate_limit_register_per_second = NULL,
  rate_limit_image = NULL,
  rate_limit_image_per_second = NULL,
  rate_limit_comment = NULL,
  rate_limit_comment_per_second = NULL,
  rate_limit_search = NULL,
  rate_limit_search_per_second = NULL,
  federation_enabled = NULL,
  federation_debug = NULL,
  captcha_enabled = NULL,
  captcha_difficulty = NULL,
  allowed_instances = NULL,
  blocked_instances = NULL,
  taglines = NULL,
  registration_mode = NULL,
  reports_email_admins = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_edit_site(
  name = NULL,
  sidebar = NULL,
  description = NULL,
  icon = NULL,
  banner = NULL,
  enable_downvotes = NULL,
  enable_nsfw = NULL,
  community_creation_admin_only = NULL,
  require_email_verification = NULL,
  application_question = NULL,
  private_instance = NULL,
  default_theme = NULL,
  default_post_listing_type = NULL,
  legal_information = NULL,
  application_email_admins = NULL,
  hide_modlog_mod_names = NULL,
  discussion_languages = NULL,
  slur_filter_regex = NULL,
  actor_name_max_length = NULL,
  rate_limit_message = NULL,
  rate_limit_message_per_second = NULL,
  rate_limit_post = NULL,
  rate_limit_post_per_second = NULL,
  rate_limit_register = NULL,
  rate_limit_register_per_second = NULL,
  rate_limit_image = NULL,
  rate_limit_image_per_second = NULL,
  rate_limit_comment = NULL,
  rate_limit_comment_per_second = NULL,
  rate_limit_search = NULL,
  rate_limit_search_per_second = NULL,
  federation_enabled = NULL,
  federation_debug = NULL,
  captcha_enabled = NULL,
  captcha_difficulty = NULL,
  allowed_instances = NULL,
  blocked_instances = NULL,
  taglines = NULL,
  registration_mode = NULL,
  reports_email_admins = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

name

(Optional) A character value.

description

(Optional) A character value.

icon

(Optional) A character value.

enable_downvotes

(Optional) A logical value.

enable_nsfw

(Optional) A logical value.

community_creation_admin_only

(Optional) A logical value.

require_email_verification

(Optional) A logical value.

application_question

(Optional) A character value.

private_instance

(Optional) A logical value.

default_theme

(Optional) A character value.

default_post_listing_type

(Optional) One of "All", "Local", or "Subscribed".

legal_information

(Optional) A character value.

application_email_admins

(Optional) A logical value.

hide_modlog_mod_names

(Optional) A logical value.

discussion_languages

(Optional) A numeric vector.

slur_filter_regex

(Optional) A character value.

actor_name_max_length

(Optional) A numeric value.

rate_limit_message

(Optional) A numeric value.

rate_limit_message_per_second

(Optional) A numeric value.

rate_limit_post

(Optional) A numeric value.

rate_limit_post_per_second

(Optional) A numeric value.

rate_limit_register

(Optional) A numeric value.

rate_limit_register_per_second

(Optional) A numeric value.

rate_limit_image

(Optional) A numeric value.

rate_limit_image_per_second

(Optional) A numeric value.

rate_limit_comment

(Optional) A numeric value.

rate_limit_comment_per_second

(Optional) A numeric value.

rate_limit_search

(Optional) A numeric value.

rate_limit_search_per_second

(Optional) A numeric value.

federation_enabled

(Optional) A logical value.

federation_debug

(Optional) A logical value.

captcha_enabled

(Optional) A logical value.

captcha_difficulty

(Optional) A character value.

allowed_instances

(Optional) A character vector.

blocked_instances

(Optional) A character vector.

taglines

(Optional) A character vector.

registration_mode

(Optional) One of "Closed", "RequireApplication", or "Open".

reports_email_admins

(Optional) A logical value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 2:

<list>
|-site_view: <list>
| |-site: <list>
| | |-id: A numeric value
| | |-name: A character value
| | |-sidebar: (Optional) A character value
| | |-published: A character value
| | |-updated: (Optional) A character value
| | |-icon: (Optional) A character value
| | |-banner: (Optional) A character value
| | |-description: (Optional) A character value
| | |-actor_id: A character value
| | |-last_refreshed_at: A character value
| | |-inbox_url: A character value
| | |-private_key: (Optional) A character value
| | |-public_key: A character value
| | `-instance_id: A numeric value
| |-local_site: <list>
| | |-id: A numeric value
| | |-site_id: A numeric value
| | |-site_setup: A logical value
| | |-enable_downvotes: A logical value
| | |-enable_nsfw: A logical value
| | |-community_creation_admin_only: A logical value
| | |-require_email_verification: A logical value
| | |-application_question: (Optional) A character value
| | |-private_instance: A logical value
| | |-default_theme: A character value
| | |-default_post_listing_type: One of "All", "Local", or "Subsc...
| | |-legal_information: (Optional) A character value
| | |-hide_modlog_mod_names: A logical value
| | |-application_email_admins: A logical value
| | |-slur_filter_regex: (Optional) A character value
| | |-actor_name_max_length: A numeric value
| | |-federation_enabled: A logical value
| | |-captcha_enabled: A logical value
| | |-captcha_difficulty: A character value
| | |-published: A character value
| | |-updated: (Optional) A character value
| | |-registration_mode: One of "Closed", "RequireApplica...
| | `-reports_email_admins: A logical value
| |-local_site_rate_limit: <list>
| | |-id: A numeric value
| | |-local_site_id: A numeric value
| | |-message: A numeric value
| | |-message_per_second: A numeric value
| | |-post: A numeric value
| | |-post_per_second: A numeric value
| | |-register: A numeric value
| | |-register_per_second: A numeric value
| | |-image: A numeric value
| | |-image_per_second: A numeric value
| | |-comment: A numeric value
| | |-comment_per_second: A numeric value
| | |-search: A numeric value
| | |-search_per_second: A numeric value
| | |-published: A character value
| | `-updated: (Optional) A character value
| `-counts: <list>
|   |-id: A numeric value
|   |-site_id: A numeric value
|   |-users: A numeric value
|   |-posts: A numeric value
|   |-comments: A numeric value
|   |-communities: A numeric value
|   |-users_active_day: A numeric value
|   |-users_active_week: A numeric value
|   |-users_active_month: A numeric value
|   `-users_active_half_year: A numeric value
`-taglines: <list>
  `-[Each element]: <list>
    |-id: A numeric value
    |-local_site_id: A numeric value
    |-content: A character value
    |-published: A character value
    `-updated: (Optional) A character value

A moderator can feature a community post ( IE stick it to the top of a community ).

Description

HTTP.POST /post/feature

Usage

lemmy_feature_post(
  post_id,
  featured,
  feature_type,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_feature_post(
  post_id,
  featured,
  feature_type,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

post_id

A numeric value.

featured

A logical value.

feature_type

One of "Local" or "Community".

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-post_view: <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

Follow / subscribe to a community.

Description

HTTP.POST /community/follow

Usage

lemmy_follow_community(
  community_id,
  follow,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_follow_community(
  community_id,
  follow,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

community_id

A numeric value.

follow

A logical value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 2:

<list>
|-community_view: <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
| |-subscribed: One of "Subscribed", "NotSubscri...
| |-blocked: A logical value
| `-counts: <list>
|   |-id: A numeric value
|   |-community_id: A numeric value
|   |-subscribers: A numeric value
|   |-posts: A numeric value
|   |-comments: A numeric value
|   |-published: A character value
|   |-users_active_day: A numeric value
|   |-users_active_week: A numeric value
|   |-users_active_month: A numeric value
|   |-users_active_half_year: A numeric value
|   `-hot_rank: A numeric value
`-discussion_languages: A numeric vector

Get a list of banned users

Description

HTTP.GET /user/banned

Usage

lemmy_get_banned_persons(
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_get_banned_persons(
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-banned: <list>
  `-[Each element]: <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

Fetch a Captcha.

Description

HTTP.GET /user/get_captcha

Usage

lemmy_get_captcha(
  auth = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_get_captcha(
  auth = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

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 1:

<list>
`-ok: <list>
  |-png: A character value
  |-wav: A character value
  `-uuid: A character value

Get / fetch comment.

Description

HTTP.GET /comment

Usage

lemmy_get_comment(
  id,
  auth = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_get_comment(
  id,
  auth = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

id

A numeric 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 3:

<list>
|-comment_view: <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
|-recipient_ids: A numeric vector
`-form_id: (Optional) A character value

Examples


comment_data <- lemmy_get_comment(546564)

comment_data$comment_view$comment$content

comment_data$comment_view$counts$score

comment_data <- lemmy_get_comment(546564)

comment_data$comment_view$comment$content

comment_data$comment_view$counts$score

Get / fetch comments.

Description

HTTP.GET /comment/list

Usage

lemmy_get_comments(
  type_ = NULL,
  sort = NULL,
  max_depth = NULL,
  page = NULL,
  limit = NULL,
  community_id = NULL,
  community_name = NULL,
  post_id = NULL,
  parent_id = NULL,
  saved_only = NULL,
  auth = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_get_comments(
  type_ = NULL,
  sort = NULL,
  max_depth = NULL,
  page = NULL,
  limit = NULL,
  community_id = NULL,
  community_name = NULL,
  post_id = NULL,
  parent_id = NULL,
  saved_only = NULL,
  auth = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

type_

(Optional) One of "All", "Local", or "Subscribed".

sort

(Optional) One of "Hot", "New", "Old", or "Top".

max_depth

(Optional) A numeric value.

page

(Optional) A numeric value.

limit

(Optional) A numeric value.

community_id

(Optional) A numeric value.

community_name

(Optional) A character value.

post_id

(Optional) A numeric value.

parent_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 1:

<list>
`-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

Examples


comment_list <- lemmy_get_comments(limit = 1, sort = "Top")

comment_list$comments[[1]]$community$name

comment_list$comments[[1]]$post$name

comment_list$comments[[1]]$comment$content

comment_list <- lemmy_get_comments(limit = 1, sort = "Top")

comment_list$comments[[1]]$community$name

comment_list$comments[[1]]$post$name

comment_list$comments[[1]]$comment$content

Get / fetch a community.

Description

HTTP.GET /community

Usage

lemmy_get_community(
  id = NULL,
  name = NULL,
  auth = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_get_community(
  id = NULL,
  name = NULL,
  auth = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

id

(Optional) A numeric value.

name

(Optional) A character 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>
|-community_view: <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
| |-subscribed: One of "Subscribed", "NotSubscri...
| |-blocked: A logical value
| `-counts: <list>
|   |-id: A numeric value
|   |-community_id: A numeric value
|   |-subscribers: A numeric value
|   |-posts: A numeric value
|   |-comments: A numeric value
|   |-published: A character value
|   |-users_active_day: A numeric value
|   |-users_active_week: A numeric value
|   |-users_active_month: A numeric value
|   |-users_active_half_year: A numeric value
|   `-hot_rank: A numeric value
|-site: <list>
| |-id: A numeric value
| |-name: A character value
| |-sidebar: (Optional) A character value
| |-published: A character value
| |-updated: (Optional) A character value
| |-icon: (Optional) A character value
| |-banner: (Optional) A character value
| |-description: (Optional) A character value
| |-actor_id: A character value
| |-last_refreshed_at: A character value
| |-inbox_url: A character value
| |-private_key: (Optional) A character value
| |-public_key: A character value
| `-instance_id: A numeric value
|-moderators: <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
`-discussion_languages: A numeric vector

Examples


community_data <- lemmy_get_community(name = "redditwasfun")

community_data$community_view$community$description

community_data <- lemmy_get_community(name = "redditwasfun")

community_data$community_view$community$description

Fetch federated instances.

Description

HTTP.Get /federated_instances

Usage

lemmy_get_federated_instances(
  auth = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_get_federated_instances(
  auth = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

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 1:

<list>
`-federated_instances: <list>
  |-linked: <list>
  | `-[Each element]: <list>
  |   |-id: A numeric value
  |   |-domain: A character value
  |   |-published: A character value
  |   |-updated: (Optional) A character value
  |   |-software: (Optional) A character value
  |   `-version: (Optional) A character value
  |-allowed: <list>
  | `-[Each element]: <list>
  |   |-id: A numeric value
  |   |-domain: A character value
  |   |-published: A character value
  |   |-updated: (Optional) A character value
  |   |-software: (Optional) A character value
  |   `-version: (Optional) A character value
  `-blocked: <list>
    `-[Each element]: <list>
      |-id: A numeric value
      |-domain: A character value
      |-published: A character value
      |-updated: (Optional) A character value
      |-software: (Optional) A character value
      `-version: (Optional) A character value

Examples


instances <- lemmy_get_federated_instances()

length(instances$federated_instances$linked)

some_instance <- instances$federated_instances$linked[[732]]

some_instance$domain

some_instance$published

instances <- lemmy_get_federated_instances()

length(instances$federated_instances$linked)

some_instance <- instances$federated_instances$linked[[732]]

some_instance$domain

some_instance$published

Get the modlog.

Description

HTTP.GET /modlog

Usage

lemmy_get_modlog(
  mod_person_id = NULL,
  community_id = NULL,
  page = NULL,
  limit = NULL,
  type_ = NULL,
  other_person_id = NULL,
  auth = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_get_modlog(
  mod_person_id = NULL,
  community_id = NULL,
  page = NULL,
  limit = NULL,
  type_ = NULL,
  other_person_id = NULL,
  auth = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

mod_person_id

(Optional) A numeric value.

community_id

(Optional) A numeric value.

page

(Optional) A numeric value.

limit

(Optional) A numeric value.

type_

(Optional) One of "All", "ModRemovePost", "ModLockPost", "ModFeaturePost", "ModRemoveComment", "ModRemoveCommunity", "ModBanFromCommunity", "ModAddCommunity", "ModTransferCommunity", "ModAdd", "ModBan", "ModHideCommunity", "AdminPurgePerson", "AdminPurgeCommunity", "AdminPurgePost", or "AdminPurgeComment".

other_person_id

(Optional) A numeric 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 15:

<list>
|-removed_posts: <list>
| `-[Each element]: <list>
|   |-mod_remove_post: <list>
|   | |-id: A numeric value
|   | |-mod_person_id: A numeric value
|   | |-post_id: A numeric value
|   | |-reason: (Optional) A character value
|   | |-removed: A logical value
|   | `-when_: A character 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
|   |-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
|-locked_posts: <list>
| `-[Each element]: <list>
|   |-mod_lock_post: <list>
|   | |-id: A numeric value
|   | |-mod_person_id: A numeric value
|   | |-post_id: A numeric value
|   | |-locked: A logical value
|   | `-when_: A character 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
|   |-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
|-featured_posts: <list>
| `-[Each element]: <list>
|   |-mod_feature_post: <list>
|   | |-id: A numeric value
|   | |-mod_person_id: A numeric value
|   | |-post_id: A numeric value
|   | |-featured: A logical value
|   | |-when_: A character value
|   | `-is_featured_community: A logical 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
|   |-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
|-removed_comments: <list>
| `-[Each element]: <list>
|   |-mod_remove_comment: <list>
|   | |-id: A numeric value
|   | |-mod_person_id: A numeric value
|   | |-comment_id: A numeric value
|   | |-reason: (Optional) A character value
|   | |-removed: A logical value
|   | `-when_: A character 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
|   |-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
|   |-commenter: <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
|-removed_communities: <list>
| `-[Each element]: <list>
|   |-mod_remove_community: <list>
|   | |-id: A numeric value
|   | |-mod_person_id: A numeric value
|   | |-community_id: A numeric value
|   | |-reason: (Optional) A character value
|   | |-removed: A logical value
|   | |-expires: (Optional) A character value
|   | `-when_: A character 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
|   `-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
|-banned_from_community: <list>
| `-[Each element]: <list>
|   |-mod_ban_from_community: <list>
|   | |-id: A numeric value
|   | |-mod_person_id: A numeric value
|   | |-other_person_id: A numeric value
|   | |-community_id: A numeric value
|   | |-reason: (Optional) A character value
|   | |-banned: A logical value
|   | |-expires: (Optional) A character value
|   | `-when_: A character 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
|   |-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
|   `-banned_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
|-banned: <list>
| `-[Each element]: <list>
|   |-mod_ban: <list>
|   | |-id: A numeric value
|   | |-mod_person_id: A numeric value
|   | |-other_person_id: A numeric value
|   | |-reason: (Optional) A character value
|   | |-banned: A logical value
|   | |-expires: (Optional) A character value
|   | `-when_: A character 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
|   `-banned_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
|-added_to_community: <list>
| `-[Each element]: <list>
|   |-mod_add_community: <list>
|   | |-id: A numeric value
|   | |-mod_person_id: A numeric value
|   | |-other_person_id: A numeric value
|   | |-community_id: A numeric value
|   | |-removed: A logical value
|   | `-when_: A character 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
|   |-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
|   `-modded_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
|-transferred_to_community: <list>
| `-[Each element]: <list>
|   |-mod_transfer_community: <list>
|   | |-id: A numeric value
|   | |-mod_person_id: A numeric value
|   | |-other_person_id: A numeric value
|   | |-community_id: A numeric value
|   | `-when_: A character 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
|   |-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
|   `-modded_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
|-added: <list>
| `-[Each element]: <list>
|   |-mod_add: <list>
|   | |-id: A numeric value
|   | |-mod_person_id: A numeric value
|   | |-other_person_id: A numeric value
|   | |-removed: A logical value
|   | `-when_: A character 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
|   `-modded_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
|-admin_purged_persons: <list>
| `-[Each element]: <list>
|   |-admin_purge_person: <list>
|   | |-id: A numeric value
|   | |-admin_person_id: A numeric value
|   | |-reason: (Optional) A character value
|   | `-when_: A character value
|   `-admin: <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
|-admin_purged_communities: <list>
| `-[Each element]: <list>
|   |-admin_purge_community: <list>
|   | |-id: A numeric value
|   | |-admin_person_id: A numeric value
|   | |-reason: (Optional) A character value
|   | `-when_: A character value
|   `-admin: <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
|-admin_purged_posts: <list>
| `-[Each element]: <list>
|   |-admin_purge_post: <list>
|   | |-id: A numeric value
|   | |-admin_person_id: A numeric value
|   | |-community_id: A numeric value
|   | |-reason: (Optional) A character value
|   | `-when_: A character value
|   |-admin: <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
|-admin_purged_comments: <list>
| `-[Each element]: <list>
|   |-admin_purge_comment: <list>
|   | |-id: A numeric value
|   | |-admin_person_id: A numeric value
|   | |-post_id: A numeric value
|   | |-reason: (Optional) A character value
|   | `-when_: A character value
|   |-admin: <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
`-hidden_communities: <list>
  `-[Each element]: <list>
    |-mod_hide_community: <list>
    | |-id: A numeric value
    | |-community_id: A numeric value
    | |-mod_person_id: A numeric value
    | |-when_: A character value
    | |-reason: (Optional) A character value
    | `-hidden: A logical value
    |-admin: <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

Get the details for a person.

Description

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")
)
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

sapply(person_data$moderates, function(x) x$community$name)

person_data <- lemmy_get_person_details(username = "ruud")

person_data$person_view$person$bio

sapply(person_data$moderates, function(x) x$community$name)

Get mentions for your user.

Description

HTTP.GET /user/mention

Usage

lemmy_get_person_mentions(
  sort = NULL,
  page = NULL,
  limit = NULL,
  unread_only = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_get_person_mentions(
  sort = NULL,
  page = NULL,
  limit = NULL,
  unread_only = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

sort

(Optional) One of "Hot", "New", "Old", or "Top".

page

(Optional) A numeric value.

limit

(Optional) A numeric value.

unread_only

(Optional) A logical value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-mentions: <list>
  `-[Each element]: <list>
    |-person_mention: <list>
    | |-id: A numeric value
    | |-recipient_id: A numeric value
    | |-comment_id: A numeric value
    | |-read: A logical value
    | `-published: A character value
    |-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
    |-recipient: <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
    | |-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

Get / fetch a post.

Description

HTTP.GET /post

Usage

lemmy_get_post(
  id = NULL,
  comment_id = NULL,
  auth = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_get_post(
  id = NULL,
  comment_id = NULL,
  auth = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

id

(Optional) A numeric value.

comment_id

(Optional) A numeric 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>
|-post_view: <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
|-community_view: <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
| |-subscribed: One of "Subscribed", "NotSubscri...
| |-blocked: A logical value
| `-counts: <list>
|   |-id: A numeric value
|   |-community_id: A numeric value
|   |-subscribers: A numeric value
|   |-posts: A numeric value
|   |-comments: A numeric value
|   |-published: A character value
|   |-users_active_day: A numeric value
|   |-users_active_week: A numeric value
|   |-users_active_month: A numeric value
|   |-users_active_half_year: A numeric value
|   `-hot_rank: A numeric value
|-moderators: <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
`-cross_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

Examples


post_data <- lemmy_get_post(1397803)

post_data$community_view$community$name

post_data$post_view$post$name

post_data <- lemmy_get_post(1397803)

post_data$community_view$community$name

post_data$post_view$post$name

Get / fetch posts, with various filters.

Description

HTTP.GET /post/list

Usage

lemmy_get_posts(
  type_ = NULL,
  sort = NULL,
  page = NULL,
  limit = NULL,
  community_id = NULL,
  community_name = NULL,
  saved_only = NULL,
  auth = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_get_posts(
  type_ = NULL,
  sort = NULL,
  page = NULL,
  limit = NULL,
  community_id = NULL,
  community_name = NULL,
  saved_only = NULL,
  auth = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

type_

(Optional) One of "All", "Local", or "Subscribed".

sort

page

(Optional) A numeric value.

limit

(Optional) A numeric value.

community_id

(Optional) A numeric value.

community_name

(Optional) A character 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 1:

<list>
`-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

Examples


post_list <- lemmy_get_posts(community_name = "showerthoughts", sort = "TopAll", limit = 1)

post_list$posts[[1]]$post$name

post_list <- lemmy_get_posts(community_name = "showerthoughts", sort = "TopAll", limit = 1)

post_list$posts[[1]]$post$name

Get / fetch private messages.

Description

HTTP.GET /private_message/list

Usage

lemmy_get_private_messages(
  unread_only = NULL,
  page = NULL,
  limit = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_get_private_messages(
  unread_only = NULL,
  page = NULL,
  limit = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

unread_only

(Optional) A logical value.

page

(Optional) A numeric value.

limit

(Optional) A numeric value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-private_messages: <list>
  `-[Each element]: <list>
    |-private_message: <list>
    | |-id: A numeric value
    | |-creator_id: A numeric value
    | |-recipient_id: A numeric value
    | |-content: A character value
    | |-deleted: A logical value
    | |-read: A logical value
    | |-published: A character value
    | |-updated: (Optional) A character value
    | |-ap_id: A character value
    | `-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
    `-recipient: <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

Get comment replies.

Description

HTTP.GET /user/replies

Usage

lemmy_get_replies(
  sort = NULL,
  page = NULL,
  limit = NULL,
  unread_only = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_get_replies(
  sort = NULL,
  page = NULL,
  limit = NULL,
  unread_only = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

sort

(Optional) One of "Hot", "New", "Old", or "Top".

page

(Optional) A numeric value.

limit

(Optional) A numeric value.

unread_only

(Optional) A logical value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-replies: <list>
  `-[Each element]: <list>
    |-comment_reply: <list>
    | |-id: A numeric value
    | |-recipient_id: A numeric value
    | |-comment_id: A numeric value
    | |-read: A logical value
    | `-published: A character value
    |-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
    |-recipient: <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
    | |-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

Get counts for your reports

Description

HTTP.GET /user/report_count

Usage

lemmy_get_report_count(
  community_id = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_get_report_count(
  community_id = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

community_id

(Optional) A numeric value.

auth

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>
|-community_id: (Optional) A numeric value
|-comment_reports: A numeric value
|-post_reports: A numeric value
`-private_message_reports: (Optional) A numeric value

Gets the site, and your user data.

Description

HTTP.GET /site

Usage

lemmy_get_site(
  auth = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_get_site(
  auth = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

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 8:

<list>
|-site_view: <list>
| |-site: <list>
| | |-id: A numeric value
| | |-name: A character value
| | |-sidebar: (Optional) A character value
| | |-published: A character value
| | |-updated: (Optional) A character value
| | |-icon: (Optional) A character value
| | |-banner: (Optional) A character value
| | |-description: (Optional) A character value
| | |-actor_id: A character value
| | |-last_refreshed_at: A character value
| | |-inbox_url: A character value
| | |-private_key: (Optional) A character value
| | |-public_key: A character value
| | `-instance_id: A numeric value
| |-local_site: <list>
| | |-id: A numeric value
| | |-site_id: A numeric value
| | |-site_setup: A logical value
| | |-enable_downvotes: A logical value
| | |-enable_nsfw: A logical value
| | |-community_creation_admin_only: A logical value
| | |-require_email_verification: A logical value
| | |-application_question: (Optional) A character value
| | |-private_instance: A logical value
| | |-default_theme: A character value
| | |-default_post_listing_type: One of "All", "Local", or "Subsc...
| | |-legal_information: (Optional) A character value
| | |-hide_modlog_mod_names: A logical value
| | |-application_email_admins: A logical value
| | |-slur_filter_regex: (Optional) A character value
| | |-actor_name_max_length: A numeric value
| | |-federation_enabled: A logical value
| | |-captcha_enabled: A logical value
| | |-captcha_difficulty: A character value
| | |-published: A character value
| | |-updated: (Optional) A character value
| | |-registration_mode: One of "Closed", "RequireApplica...
| | `-reports_email_admins: A logical value
| |-local_site_rate_limit: <list>
| | |-id: A numeric value
| | |-local_site_id: A numeric value
| | |-message: A numeric value
| | |-message_per_second: A numeric value
| | |-post: A numeric value
| | |-post_per_second: A numeric value
| | |-register: A numeric value
| | |-register_per_second: A numeric value
| | |-image: A numeric value
| | |-image_per_second: A numeric value
| | |-comment: A numeric value
| | |-comment_per_second: A numeric value
| | |-search: A numeric value
| | |-search_per_second: A numeric value
| | |-published: A character value
| | `-updated: (Optional) A character value
| `-counts: <list>
|   |-id: A numeric value
|   |-site_id: A numeric value
|   |-users: A numeric value
|   |-posts: A numeric value
|   |-comments: A numeric value
|   |-communities: A numeric value
|   |-users_active_day: A numeric value
|   |-users_active_week: A numeric value
|   |-users_active_month: A numeric value
|   `-users_active_half_year: A numeric value
|-admins: <list>
| `-[Each element]: <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
|-version: A character value
|-my_user: <list>
| |-local_user_view: <list>
| | |-local_user: <list>
| | | |-id: A numeric value
| | | |-person_id: A numeric value
| | | |-email: (Optional) A character value
| | | |-show_nsfw: A logical value
| | | |-theme: A character value
| | | |-default_sort_type: One of "Active", "Hot", "New", "...
| | | |-default_listing_type: One of "All", "Local", or "Subsc...
| | | |-interface_language: A character value
| | | |-show_avatars: A logical value
| | | |-send_notifications_to_email: A logical value
| | | |-validator_time: A character value
| | | |-show_scores: A logical value
| | | |-show_bot_accounts: A logical value
| | | |-show_read_posts: A logical value
| | | |-show_new_post_notifs: A logical value
| | | |-email_verified: A logical value
| | | |-accepted_application: A logical value
| | | |-totp_2fa_url: (Optional) A character value
| | | `-open_links_in_new_tab: A logical value
| | |-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
| |-follows: <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
| |   `-follower: <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
| |-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
| |-community_blocks: <list>
| | `-[Each element]: <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
| |   `-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
| |-person_blocks: <list>
| | `-[Each element]: <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
| |   `-target: <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
| `-discussion_languages: A numeric vector
|-all_languages: <list>
| `-[Each element]: <list>
|   |-id: A numeric value
|   |-code: A character value
|   `-name: A character value
|-discussion_languages: A numeric vector
|-taglines: <list>
| `-[Each element]: <list>
|   |-id: A numeric value
|   |-local_site_id: A numeric value
|   |-content: A character value
|   |-published: A character value
|   `-updated: (Optional) A character value
`-custom_emojis: <list>
  `-[Each element]: <list>
    |-custom_emoji: <list>
    | |-id: A numeric value
    | |-local_site_id: A numeric value
    | |-shortcode: A character value
    | |-image_url: A character value
    | |-alt_text: A character value
    | |-category: A character value
    | |-published: A character value
    | `-updated: (Optional) A character value
    `-keywords: <list>
      `-[Each element]: <list>
        |-id: A numeric value
        |-custom_emoji_id: A numeric value
        `-keyword: A character value

Examples


site_data <- lemmy_get_site()

site_data$site_view$site$name

site_data$site_view$counts$users

site_data <- lemmy_get_site()

site_data$site_view$site$name

site_data$site_view$counts$users

Fetch metadata for any given site.

Description

HTTP.GET /post/site_metadata

Usage

lemmy_get_site_metadata(
  url,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_get_site_metadata(
  url,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

url

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-metadata: <list>
  |-title: (Optional) A character value
  |-description: (Optional) A character value
  |-image: (Optional) A character value
  `-embed_video_url: (Optional) A character value

Examples


site_metadata <- lemmy_get_site_metadata("https://feddit.de")

site_metadata$metadata$title

site_metadata <- lemmy_get_site_metadata("https://feddit.de")

site_metadata$metadata$title

Get your unread counts

Description

HTTP.GET /user/unread_count

Usage

lemmy_get_unread_count(
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_get_unread_count(
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

auth

A character value.

.lemmy_instance

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

Value

A list of length 3:

<list>
|-replies: A numeric value
|-mentions: A numeric value
`-private_messages: A numeric value

Get the unread registration applications count.

Description

HTTP.GET /admin/registration_application/count

Usage

lemmy_get_unread_registration_application_count(
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_get_unread_registration_application_count(
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-registration_applications: A numeric value

Leave the Site admins.

Description

HTTP.POST /user/leave_admin

Usage

lemmy_leave_admin(
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_leave_admin(
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

auth

A character value.

.lemmy_instance

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

Value

A list of length 8:

<list>
|-site_view: <list>
| |-site: <list>
| | |-id: A numeric value
| | |-name: A character value
| | |-sidebar: (Optional) A character value
| | |-published: A character value
| | |-updated: (Optional) A character value
| | |-icon: (Optional) A character value
| | |-banner: (Optional) A character value
| | |-description: (Optional) A character value
| | |-actor_id: A character value
| | |-last_refreshed_at: A character value
| | |-inbox_url: A character value
| | |-private_key: (Optional) A character value
| | |-public_key: A character value
| | `-instance_id: A numeric value
| |-local_site: <list>
| | |-id: A numeric value
| | |-site_id: A numeric value
| | |-site_setup: A logical value
| | |-enable_downvotes: A logical value
| | |-enable_nsfw: A logical value
| | |-community_creation_admin_only: A logical value
| | |-require_email_verification: A logical value
| | |-application_question: (Optional) A character value
| | |-private_instance: A logical value
| | |-default_theme: A character value
| | |-default_post_listing_type: One of "All", "Local", or "Subsc...
| | |-legal_information: (Optional) A character value
| | |-hide_modlog_mod_names: A logical value
| | |-application_email_admins: A logical value
| | |-slur_filter_regex: (Optional) A character value
| | |-actor_name_max_length: A numeric value
| | |-federation_enabled: A logical value
| | |-captcha_enabled: A logical value
| | |-captcha_difficulty: A character value
| | |-published: A character value
| | |-updated: (Optional) A character value
| | |-registration_mode: One of "Closed", "RequireApplica...
| | `-reports_email_admins: A logical value
| |-local_site_rate_limit: <list>
| | |-id: A numeric value
| | |-local_site_id: A numeric value
| | |-message: A numeric value
| | |-message_per_second: A numeric value
| | |-post: A numeric value
| | |-post_per_second: A numeric value
| | |-register: A numeric value
| | |-register_per_second: A numeric value
| | |-image: A numeric value
| | |-image_per_second: A numeric value
| | |-comment: A numeric value
| | |-comment_per_second: A numeric value
| | |-search: A numeric value
| | |-search_per_second: A numeric value
| | |-published: A character value
| | `-updated: (Optional) A character value
| `-counts: <list>
|   |-id: A numeric value
|   |-site_id: A numeric value
|   |-users: A numeric value
|   |-posts: A numeric value
|   |-comments: A numeric value
|   |-communities: A numeric value
|   |-users_active_day: A numeric value
|   |-users_active_week: A numeric value
|   |-users_active_month: A numeric value
|   `-users_active_half_year: A numeric value
|-admins: <list>
| `-[Each element]: <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
|-version: A character value
|-my_user: <list>
| |-local_user_view: <list>
| | |-local_user: <list>
| | | |-id: A numeric value
| | | |-person_id: A numeric value
| | | |-email: (Optional) A character value
| | | |-show_nsfw: A logical value
| | | |-theme: A character value
| | | |-default_sort_type: One of "Active", "Hot", "New", "...
| | | |-default_listing_type: One of "All", "Local", or "Subsc...
| | | |-interface_language: A character value
| | | |-show_avatars: A logical value
| | | |-send_notifications_to_email: A logical value
| | | |-validator_time: A character value
| | | |-show_scores: A logical value
| | | |-show_bot_accounts: A logical value
| | | |-show_read_posts: A logical value
| | | |-show_new_post_notifs: A logical value
| | | |-email_verified: A logical value
| | | |-accepted_application: A logical value
| | | |-totp_2fa_url: (Optional) A character value
| | | `-open_links_in_new_tab: A logical value
| | |-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
| |-follows: <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
| |   `-follower: <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
| |-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
| |-community_blocks: <list>
| | `-[Each element]: <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
| |   `-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
| |-person_blocks: <list>
| | `-[Each element]: <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
| |   `-target: <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
| `-discussion_languages: A numeric vector
|-all_languages: <list>
| `-[Each element]: <list>
|   |-id: A numeric value
|   |-code: A character value
|   `-name: A character value
|-discussion_languages: A numeric vector
|-taglines: <list>
| `-[Each element]: <list>
|   |-id: A numeric value
|   |-local_site_id: A numeric value
|   |-content: A character value
|   |-published: A character value
|   `-updated: (Optional) A character value
`-custom_emojis: <list>
  `-[Each element]: <list>
    |-custom_emoji: <list>
    | |-id: A numeric value
    | |-local_site_id: A numeric value
    | |-shortcode: A character value
    | |-image_url: A character value
    | |-alt_text: A character value
    | |-category: A character value
    | |-published: A character value
    | `-updated: (Optional) A character value
    `-keywords: <list>
      `-[Each element]: <list>
        |-id: A numeric value
        |-custom_emoji_id: A numeric value
        `-keyword: A character value

Like / vote on a comment.

Description

HTTP.POST /comment/like

Usage

lemmy_like_comment(
  comment_id,
  score,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_like_comment(
  comment_id,
  score,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

comment_id

A numeric value.

score

A numeric value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 3:

<list>
|-comment_view: <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
|-recipient_ids: A numeric vector
`-form_id: (Optional) A character value

Like / vote on a post.

Description

HTTP.POST /post/like

Usage

lemmy_like_post(
  post_id,
  score,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_like_post(
  post_id,
  score,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

post_id

A numeric value.

score

A numeric value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-post_view: <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

List comment reports.

Description

HTTP.GET /comment/report/list

Usage

lemmy_list_comment_reports(
  page = NULL,
  limit = NULL,
  unresolved_only = NULL,
  community_id = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_list_comment_reports(
  page = NULL,
  limit = NULL,
  unresolved_only = NULL,
  community_id = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

page

(Optional) A numeric value.

limit

(Optional) A numeric value.

unresolved_only

(Optional) A logical value.

community_id

(Optional) A numeric value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-comment_reports: <list>
  `-[Each element]: <list>
    |-comment_report: <list>
    | |-id: A numeric value
    | |-creator_id: A numeric value
    | |-comment_id: A numeric value
    | |-original_comment_text: A character value
    | |-reason: A character value
    | |-resolved: A logical value
    | |-resolver_id: (Optional) A numeric value
    | |-published: A character value
    | `-updated: (Optional) A character value
    |-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
    |-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
    |-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
    |-comment_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
    |-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
    |-my_vote: (Optional) A numeric value
    `-resolver: <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

List communities, with various filters.

Description

HTTP.GET /community/list

Usage

lemmy_list_communities(
  type_ = NULL,
  sort = NULL,
  show_nsfw = NULL,
  page = NULL,
  limit = NULL,
  auth = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_list_communities(
  type_ = NULL,
  sort = NULL,
  show_nsfw = NULL,
  page = NULL,
  limit = NULL,
  auth = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

type_

(Optional) One of "All", "Local", or "Subscribed".

sort

show_nsfw

(Optional) A logical value.

page

(Optional) A numeric value.

limit

(Optional) A numeric 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 1:

<list>
`-communities: <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
    |-subscribed: One of "Subscribed", "NotSubscri...
    |-blocked: A logical value
    `-counts: <list>
      |-id: A numeric value
      |-community_id: A numeric value
      |-subscribers: A numeric value
      |-posts: A numeric value
      |-comments: A numeric value
      |-published: A character value
      |-users_active_day: A numeric value
      |-users_active_week: A numeric value
      |-users_active_month: A numeric value
      |-users_active_half_year: A numeric value
      `-hot_rank: A numeric value

Examples


community_list <- lemmy_list_communities(sort = "TopMonth", limit = 1)

community_list$communities[[1]]$community$name

community_list <- lemmy_list_communities(sort = "TopMonth", limit = 1)

community_list$communities[[1]]$community$name

List post reports.

Description

HTTP.GET /post/report/list

Usage

lemmy_list_post_reports(
  page = NULL,
  limit = NULL,
  unresolved_only = NULL,
  community_id = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_list_post_reports(
  page = NULL,
  limit = NULL,
  unresolved_only = NULL,
  community_id = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

page

(Optional) A numeric value.

limit

(Optional) A numeric value.

unresolved_only

(Optional) A logical value.

community_id

(Optional) A numeric value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-post_reports: <list>
  `-[Each element]: <list>
    |-post_report: <list>
    | |-id: A numeric value
    | |-creator_id: A numeric value
    | |-post_id: A numeric value
    | |-original_post_name: A character value
    | |-original_post_url: (Optional) A character value
    | |-original_post_body: (Optional) A character value
    | |-reason: A character value
    | |-resolved: A logical value
    | |-resolver_id: (Optional) A numeric value
    | |-published: A character value
    | `-updated: (Optional) A character 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
    |-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_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
    |-creator_banned_from_community: A logical value
    |-my_vote: (Optional) A numeric 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
    `-resolver: <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

List private message reports.

Description

HTTP.GET /private_message/report/list

Usage

lemmy_list_private_message_reports(
  page = NULL,
  limit = NULL,
  unresolved_only = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_list_private_message_reports(
  page = NULL,
  limit = NULL,
  unresolved_only = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

page

(Optional) A numeric value.

limit

(Optional) A numeric value.

unresolved_only

(Optional) A logical value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-private_message_reports: <list>
  `-[Each element]: <list>
    |-private_message_report: <list>
    | |-id: A numeric value
    | |-creator_id: A numeric value
    | |-private_message_id: A numeric value
    | |-original_pm_text: A character value
    | |-reason: A character value
    | |-resolved: A logical value
    | |-resolver_id: (Optional) A numeric value
    | |-published: A character value
    | `-updated: (Optional) A character value
    |-private_message: <list>
    | |-id: A numeric value
    | |-creator_id: A numeric value
    | |-recipient_id: A numeric value
    | |-content: A character value
    | |-deleted: A logical value
    | |-read: A logical value
    | |-published: A character value
    | |-updated: (Optional) A character value
    | |-ap_id: A character value
    | `-local: A logical value
    |-private_message_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
    |-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
    `-resolver: <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

List the registration applications.

Description

HTTP.GET /admin/registration_application/list

Usage

lemmy_list_registration_applications(
  unread_only = NULL,
  page = NULL,
  limit = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_list_registration_applications(
  unread_only = NULL,
  page = NULL,
  limit = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

unread_only

(Optional) A logical value.

page

(Optional) A numeric value.

limit

(Optional) A numeric value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-registration_applications: <list>
  `-[Each element]: <list>
    |-registration_application: <list>
    | |-id: A numeric value
    | |-local_user_id: A numeric value
    | |-answer: A character value
    | |-admin_id: (Optional) A numeric value
    | |-deny_reason: (Optional) A character value
    | `-published: A character value
    |-creator_local_user: <list>
    | |-id: A numeric value
    | |-person_id: A numeric value
    | |-email: (Optional) A character value
    | |-show_nsfw: A logical value
    | |-theme: A character value
    | |-default_sort_type: One of "Active", "Hot", "New", "...
    | |-default_listing_type: One of "All", "Local", or "Subsc...
    | |-interface_language: A character value
    | |-show_avatars: A logical value
    | |-send_notifications_to_email: A logical value
    | |-validator_time: A character value
    | |-show_scores: A logical value
    | |-show_bot_accounts: A logical value
    | |-show_read_posts: A logical value
    | |-show_new_post_notifs: A logical value
    | |-email_verified: A logical value
    | |-accepted_application: A logical value
    | |-totp_2fa_url: (Optional) A character value
    | `-open_links_in_new_tab: 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
    `-admin: <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

A moderator can lock a post ( IE disable new comments ).

Description

HTTP.POST /post/lock

Usage

lemmy_lock_post(
  post_id,
  locked,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_lock_post(
  post_id,
  locked,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

post_id

A numeric value.

locked

A logical value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-post_view: <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

Log into lemmy.

Description

HTTP.POST /user/login

Usage

lemmy_login(
  username_or_email,
  password,
  totp_2fa_token = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_login(
  username_or_email,
  password,
  totp_2fa_token = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

username_or_email

A character value.

password

A character value.

totp_2fa_token

(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 3:

<list>
|-jwt: (Optional) A character value
|-registration_created: A logical value
`-verify_email_sent: A logical value

Mark all replies as read.

Description

HTTP.POST /user/mark_all_as_read

Usage

lemmy_mark_all_as_read(
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_mark_all_as_read(
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-replies: <list>
  `-[Each element]: <list>
    |-comment_reply: <list>
    | |-id: A numeric value
    | |-recipient_id: A numeric value
    | |-comment_id: A numeric value
    | |-read: A logical value
    | `-published: A character value
    |-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
    |-recipient: <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
    | |-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

Mark a comment as read.

Description

HTTP.POST /comment/mark_as_read

Usage

lemmy_mark_comment_reply_as_read(
  comment_reply_id,
  read,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_mark_comment_reply_as_read(
  comment_reply_id,
  read,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

comment_reply_id

A numeric value.

read

A logical value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-comment_reply_view: <list>
  |-comment_reply: <list>
  | |-id: A numeric value
  | |-recipient_id: A numeric value
  | |-comment_id: A numeric value
  | |-read: A logical value
  | `-published: A character value
  |-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
  |-recipient: <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
  | |-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

Mark a person mention as read.

Description

HTTP.POST /user/mention/mark_as_read

Usage

lemmy_mark_person_mention_as_read(
  person_mention_id,
  read,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_mark_person_mention_as_read(
  person_mention_id,
  read,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

person_mention_id

A numeric value.

read

A logical value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-person_mention_view: <list>
  |-person_mention: <list>
  | |-id: A numeric value
  | |-recipient_id: A numeric value
  | |-comment_id: A numeric value
  | |-read: A logical value
  | `-published: A character value
  |-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
  |-recipient: <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
  | |-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

Mark a post as read.

Description

HTTP.POST /post/mark_as_read

Usage

lemmy_mark_post_as_read(
  post_id,
  read,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_mark_post_as_read(
  post_id,
  read,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

post_id

A numeric value.

read

A logical value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-post_view: <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

Mark a private message as read.

Description

HTTP.POST /private_message/mark_as_read

Usage

lemmy_mark_private_message_as_read(
  private_message_id,
  read,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_mark_private_message_as_read(
  private_message_id,
  read,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

private_message_id

A numeric value.

read

A logical value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-private_message_view: <list>
  |-private_message: <list>
  | |-id: A numeric value
  | |-creator_id: A numeric value
  | |-recipient_id: A numeric value
  | |-content: A character value
  | |-deleted: A logical value
  | |-read: A logical value
  | |-published: A character value
  | |-updated: (Optional) A character value
  | |-ap_id: A character value
  | `-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
  `-recipient: <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

Change your password from an email / token based reset.

Description

HTTP.POST /user/password_change

Usage

lemmy_password_change_after_reset(
  token,
  password,
  password_verify,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_password_change_after_reset(
  token,
  password,
  password_verify,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

token

A character value.

password

A character value.

password_verify

A character value.

.lemmy_instance

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

Value

A list of length 3:

<list>
|-jwt: (Optional) A character value
|-registration_created: A logical value
`-verify_email_sent: A logical value

Reset your password.

Description

HTTP.POST /user/password_reset

Usage

lemmy_password_reset(
  email,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_password_reset(
  email,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

email

A character value.

.lemmy_instance

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

Value

A list of length 0:

<list>

Purge / Delete a comment from the database.

Description

HTTP.POST /admin/purge/comment

Usage

lemmy_purge_comment(
  comment_id,
  reason = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_purge_comment(
  comment_id,
  reason = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

comment_id

A numeric value.

reason

(Optional) A character value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-success: A logical value

Purge / Delete a community from the database.

Description

HTTP.POST /admin/purge/community

Usage

lemmy_purge_community(
  community_id,
  reason = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_purge_community(
  community_id,
  reason = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

community_id

A numeric value.

reason

(Optional) A character value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-success: A logical value

Purge / Delete a person from the database.

Description

HTTP.POST /admin/purge/person

Usage

lemmy_purge_person(
  person_id,
  reason = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_purge_person(
  person_id,
  reason = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

person_id

A numeric value.

reason

(Optional) A character value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-success: A logical value

Purge / Delete a post from the database.

Description

HTTP.POST /admin/purge/post

Usage

lemmy_purge_post(
  post_id,
  reason = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_purge_post(
  post_id,
  reason = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

post_id

A numeric value.

reason

(Optional) A character value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-success: A logical value

Register a new user.

Description

HTTP.POST /user/register

Usage

lemmy_register(
  username,
  password,
  password_verify,
  show_nsfw,
  email = NULL,
  captcha_uuid = NULL,
  captcha_answer = NULL,
  honeypot = NULL,
  answer = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_register(
  username,
  password,
  password_verify,
  show_nsfw,
  email = NULL,
  captcha_uuid = NULL,
  captcha_answer = NULL,
  honeypot = NULL,
  answer = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

username

A character value.

password

A character value.

password_verify

A character value.

show_nsfw

A logical value.

email

(Optional) A character value.

captcha_uuid

(Optional) A character value.

captcha_answer

(Optional) A character value.

honeypot

(Optional) A character value.

answer

(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 3:

<list>
|-jwt: (Optional) A character value
|-registration_created: A logical value
`-verify_email_sent: A logical value

A moderator remove for a comment.

Description

HTTP.POST /comment/remove

Usage

lemmy_remove_comment(
  comment_id,
  removed,
  reason = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_remove_comment(
  comment_id,
  removed,
  reason = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

comment_id

A numeric value.

removed

A logical value.

reason

(Optional) A character value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 3:

<list>
|-comment_view: <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
|-recipient_ids: A numeric vector
`-form_id: (Optional) A character value

A moderator remove for a community.

Description

HTTP.POST /community/remove

Usage

lemmy_remove_community(
  community_id,
  removed,
  reason = NULL,
  expires = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_remove_community(
  community_id,
  removed,
  reason = NULL,
  expires = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

community_id

A numeric value.

removed

A logical value.

reason

(Optional) A character value.

expires

(Optional) A numeric value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 2:

<list>
|-community_view: <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
| |-subscribed: One of "Subscribed", "NotSubscri...
| |-blocked: A logical value
| `-counts: <list>
|   |-id: A numeric value
|   |-community_id: A numeric value
|   |-subscribers: A numeric value
|   |-posts: A numeric value
|   |-comments: A numeric value
|   |-published: A character value
|   |-users_active_day: A numeric value
|   |-users_active_week: A numeric value
|   |-users_active_month: A numeric value
|   |-users_active_half_year: A numeric value
|   `-hot_rank: A numeric value
`-discussion_languages: A numeric vector

A moderator remove for a post.

Description

HTTP.POST /post/remove

Usage

lemmy_remove_post(
  post_id,
  removed,
  reason = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_remove_post(
  post_id,
  removed,
  reason = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

post_id

A numeric value.

removed

A logical value.

reason

(Optional) A character value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-post_view: <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

Resolve a comment report. Only a mod can do this.

Description

HTTP.PUT /comment/report/resolve

Usage

lemmy_resolve_comment_report(
  report_id,
  resolved,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_resolve_comment_report(
  report_id,
  resolved,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

report_id

A numeric value.

resolved

A logical value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-comment_report_view: <list>
  |-comment_report: <list>
  | |-id: A numeric value
  | |-creator_id: A numeric value
  | |-comment_id: A numeric value
  | |-original_comment_text: A character value
  | |-reason: A character value
  | |-resolved: A logical value
  | |-resolver_id: (Optional) A numeric value
  | |-published: A character value
  | `-updated: (Optional) A character value
  |-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
  |-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
  |-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
  |-comment_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
  |-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
  |-my_vote: (Optional) A numeric value
  `-resolver: <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

Fetch a non-local / federated object.

Description

HTTP.GET /resolve_object

Usage

lemmy_resolve_object(
  q,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_resolve_object(
  q,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

q

A character value.

auth

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>
|-comment: <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
|-post: <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
|-community: <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
| |-subscribed: One of "Subscribed", "NotSubscri...
| |-blocked: A logical value
| `-counts: <list>
|   |-id: A numeric value
|   |-community_id: A numeric value
|   |-subscribers: A numeric value
|   |-posts: A numeric value
|   |-comments: A numeric value
|   |-published: A character value
|   |-users_active_day: A numeric value
|   |-users_active_week: A numeric value
|   |-users_active_month: A numeric value
|   |-users_active_half_year: A numeric value
|   `-hot_rank: A numeric value
`-person: <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

Resolve a post report. Only a mod can do this.

Description

HTTP.PUT /post/report/resolve

Usage

lemmy_resolve_post_report(
  report_id,
  resolved,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_resolve_post_report(
  report_id,
  resolved,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

report_id

A numeric value.

resolved

A logical value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-post_report_view: <list>
  |-post_report: <list>
  | |-id: A numeric value
  | |-creator_id: A numeric value
  | |-post_id: A numeric value
  | |-original_post_name: A character value
  | |-original_post_url: (Optional) A character value
  | |-original_post_body: (Optional) A character value
  | |-reason: A character value
  | |-resolved: A logical value
  | |-resolver_id: (Optional) A numeric value
  | |-published: A character value
  | `-updated: (Optional) A character 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
  |-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_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
  |-creator_banned_from_community: A logical value
  |-my_vote: (Optional) A numeric 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
  `-resolver: <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

Resolve a report for a private message.

Description

HTTP.PUT /private_message/report/resolve

Usage

lemmy_resolve_private_message_report(
  report_id,
  resolved,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_resolve_private_message_report(
  report_id,
  resolved,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

report_id

A numeric value.

resolved

A logical value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-private_message_report_view: <list>
  |-private_message_report: <list>
  | |-id: A numeric value
  | |-creator_id: A numeric value
  | |-private_message_id: A numeric value
  | |-original_pm_text: A character value
  | |-reason: A character value
  | |-resolved: A logical value
  | |-resolver_id: (Optional) A numeric value
  | |-published: A character value
  | `-updated: (Optional) A character value
  |-private_message: <list>
  | |-id: A numeric value
  | |-creator_id: A numeric value
  | |-recipient_id: A numeric value
  | |-content: A character value
  | |-deleted: A logical value
  | |-read: A logical value
  | |-published: A character value
  | |-updated: (Optional) A character value
  | |-ap_id: A character value
  | `-local: A logical value
  |-private_message_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
  |-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
  `-resolver: <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

Save a comment.

Description

HTTP.PUT /comment/save

Usage

lemmy_save_comment(
  comment_id,
  save,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_save_comment(
  comment_id,
  save,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

comment_id

A numeric value.

save

A logical value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 3:

<list>
|-comment_view: <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
|-recipient_ids: A numeric vector
`-form_id: (Optional) A character value

Save a post.

Description

HTTP.PUT /post/save

Usage

lemmy_save_post(
  post_id,
  save,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_save_post(
  post_id,
  save,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

post_id

A numeric value.

save

A logical value.

auth

A character value.

.lemmy_instance

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

Value

A list of length 1:

<list>
`-post_view: <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

Save your user settings.

Description

HTTP.PUT /user/save_user_settings

Usage

lemmy_save_user_settings(
  show_nsfw = NULL,
  show_scores = NULL,
  theme = NULL,
  default_sort_type = NULL,
  default_listing_type = NULL,
  interface_language = NULL,
  avatar = NULL,
  banner = NULL,
  display_name = NULL,
  email = NULL,
  bio = NULL,
  matrix_user_id = NULL,
  show_avatars = NULL,
  send_notifications_to_email = NULL,
  bot_account = NULL,
  show_bot_accounts = NULL,
  show_read_posts = NULL,
  show_new_post_notifs = NULL,
  discussion_languages = NULL,
  generate_totp_2fa = NULL,
  auth,
  open_links_in_new_tab = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_save_user_settings(
  show_nsfw = NULL,
  show_scores = NULL,
  theme = NULL,
  default_sort_type = NULL,
  default_listing_type = NULL,
  interface_language = NULL,
  avatar = NULL,
  banner = NULL,
  display_name = NULL,
  email = NULL,
  bio = NULL,
  matrix_user_id = NULL,
  show_avatars = NULL,
  send_notifications_to_email = NULL,
  bot_account = NULL,
  show_bot_accounts = NULL,
  show_read_posts = NULL,
  show_new_post_notifs = NULL,
  discussion_languages = NULL,
  generate_totp_2fa = NULL,
  auth,
  open_links_in_new_tab = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

show_nsfw

(Optional) A logical value.

show_scores

(Optional) A logical value.

theme

(Optional) A character value.

default_sort_type

default_listing_type

(Optional) One of "All", "Local", or "Subscribed".

interface_language

(Optional) A character value.

avatar

(Optional) A character value.

display_name

(Optional) A character value.

email

(Optional) A character value.

bio

(Optional) A character value.

matrix_user_id

(Optional) A character value.

show_avatars

(Optional) A logical value.

send_notifications_to_email

(Optional) A logical value.

bot_account

(Optional) A logical value.

show_bot_accounts

(Optional) A logical value.

show_read_posts

(Optional) A logical value.

show_new_post_notifs

(Optional) A logical value.

discussion_languages

(Optional) A numeric vector.

generate_totp_2fa

(Optional) A logical value.

auth

A character value.

open_links_in_new_tab

(Optional) A logical value.

.lemmy_instance

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

Value

A list of length 3:

<list>
|-jwt: (Optional) A character value
|-registration_created: A logical value
`-verify_email_sent: A logical value

Search lemmy.

Description

HTTP.GET /search

Usage

lemmy_search(
  q,
  community_id = NULL,
  community_name = NULL,
  creator_id = NULL,
  type_ = NULL,
  sort = NULL,
  listing_type = NULL,
  page = NULL,
  limit = NULL,
  auth = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_search(
  q,
  community_id = NULL,
  community_name = NULL,
  creator_id = NULL,
  type_ = NULL,
  sort = NULL,
  listing_type = NULL,
  page = NULL,
  limit = NULL,
  auth = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

q

A character value.

community_id

(Optional) A numeric value.

community_name

(Optional) A character value.

creator_id

(Optional) A numeric value.

type_

(Optional) One of "All", "Comments", "Posts", "Communities", "Users", or "Url".

sort

listing_type

(Optional) One of "All", "Local", or "Subscribed".

page

(Optional) A numeric value.

limit

(Optional) A numeric 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 5:

<list>
|-type_: One of "All", "Comments", "Posts...
|-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
|-communities: <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
|   |-subscribed: One of "Subscribed", "NotSubscri...
|   |-blocked: A logical value
|   `-counts: <list>
|     |-id: A numeric value
|     |-community_id: A numeric value
|     |-subscribers: A numeric value
|     |-posts: A numeric value
|     |-comments: A numeric value
|     |-published: A character value
|     |-users_active_day: A numeric value
|     |-users_active_week: A numeric value
|     |-users_active_month: A numeric value
|     |-users_active_half_year: A numeric value
|     `-hot_rank: A numeric value
`-users: <list>
  `-[Each element]: <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

Examples


search_results <- lemmy_search("Liverpool", type_ = "Posts", sort = "TopAll", limit = 1)

search_results$posts[[1]]$community$name

search_results$posts[[1]]$post$name

search_results <- lemmy_search("Liverpool", type_ = "Posts", sort = "TopAll", limit = 1)

search_results$posts[[1]]$community$name

search_results$posts[[1]]$post$name

Transfer your community to an existing moderator.

Description

HTTP.POST /community/transfer

Usage

lemmy_transfer_community(
  community_id,
  person_id,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_transfer_community(
  community_id,
  person_id,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

community_id

A numeric value.

person_id

A numeric value.

auth

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>
|-community_view: <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
| |-subscribed: One of "Subscribed", "NotSubscri...
| |-blocked: A logical value
| `-counts: <list>
|   |-id: A numeric value
|   |-community_id: A numeric value
|   |-subscribers: A numeric value
|   |-posts: A numeric value
|   |-comments: A numeric value
|   |-published: A character value
|   |-users_active_day: A numeric value
|   |-users_active_week: A numeric value
|   |-users_active_month: A numeric value
|   |-users_active_half_year: A numeric value
|   `-hot_rank: A numeric value
|-site: <list>
| |-id: A numeric value
| |-name: A character value
| |-sidebar: (Optional) A character value
| |-published: A character value
| |-updated: (Optional) A character value
| |-icon: (Optional) A character value
| |-banner: (Optional) A character value
| |-description: (Optional) A character value
| |-actor_id: A character value
| |-last_refreshed_at: A character value
| |-inbox_url: A character value
| |-private_key: (Optional) A character value
| |-public_key: A character value
| `-instance_id: A numeric value
|-moderators: <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
`-discussion_languages: A numeric vector

Verify your email

Description

HTTP.POST /user/verify_email

Usage

lemmy_verify_email(
  token,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)
lemmy_verify_email(
  token,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

token

A character value.

.lemmy_instance

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

Value

A list of length 0:

<list>