lemmy_search: Search lemmy.
In remmy: API Client for 'Lemmy'
lemmy_search R Documentation
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")
)
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
(Optional) One of "Active", "Hot", "New", "Old", "TopDay", "TopWeek", "TopMonth", "TopYear", "TopAll", "MostComments", "NewComments", "TopHour", "TopSixHour", "TopTwelveHour", "TopThreeMonths", "TopSixMonths", or "TopNineMonths".
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
remmy documentation built on July 26, 2023, 5:37 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| lemmy_search | R Documentation |
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")
)
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 |
(Optional) One of "Active", "Hot", "New", "Old", "TopDay", "TopWeek", "TopMonth", "TopYear", "TopAll", "MostComments", "NewComments", "TopHour", "TopSixHour", "TopTwelveHour", "TopThreeMonths", "TopSixMonths", or "TopNineMonths". |
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 |
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
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.