Package 'bskyr' reference manual

Title:	Interact with 'Bluesky' Social
Description:	Collect data from and make posts on 'Bluesky' Social via the Hypertext Transfer Protocol (HTTP) Application Programming Interface (API), as documented at <https://atproto.com/specs/xrpc>. This further supports broader queries to the Authenticated Transfer (AT) Protocol <https://atproto.com/> which 'Bluesky' Social relies on. Data is returned in a tidy format and posts can be made using a simple interface.
Authors:	Christopher T. Kenny [aut, cre]
Maintainer:	Christopher T. Kenny <[email protected]>
License:	MIT + file LICENSE
Version:	0.1.3
Built:	2024-10-04 02:59:18 UTC
Source:	https://github.com/christopherkenny/bskyr

Authenticate a user

Description

Authenticate a user

Usage

bs_auth(user, pass, save_auth = TRUE)
bs_auth(user, pass, save_auth = TRUE)

Arguments

`user`	Character. User name to log in with.
`pass`	Character. App password to log in with.
`save_auth`	Logical. Should the authentication information be saved? If `TRUE`, it tries to reload from the cache. If a file is over 10 minutes old, it will not be read. Set `save_auth = NULL` to force the token to refresh and save the results.

Value

a list of authentication information

Lexicon references

server/createSession.json (2023-09-30)

Function introduced

v0.0.1 (2023-09-30)

Examples


bs_auth(user = get_bluesky_user(), pass = get_bluesky_pass())

bs_auth(user = get_bluesky_user(), pass = get_bluesky_pass())

Create a record in a repo

Description

Create a record in a repo

Usage

bs_create_record(
  collection,
  record,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_create_record(
  collection,
  record,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`collection`	Character, length 1. The NSID of the record collection.
`record`	List, length 1. Description of a record.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of record information

Lexicon references

repo/createRecord.json (2023-11-25)

Function introduced

v0.1.0 (2023-11-25)

Examples


# get info about a record
post_rcd <- bs_get_record('https://bsky.app/profile/bskyr.bsky.social/post/3kf2577exva2x')
# create a record, to like the post
like <- list(
  subject = list(
    uri = post_rcd$uri,
    cid = post_rcd$cid
  ),
  createdAt = bs_created_at()
)

bs_create_record(collection = 'app.bsky.feed.like', record = like)

# get info about a record
post_rcd <- bs_get_record('https://bsky.app/profile/bskyr.bsky.social/post/3kf2577exva2x')
# create a record, to like the post
like <- list(
  subject = list(
    uri = post_rcd$uri,
    cid = post_rcd$cid
  ),
  createdAt = bs_created_at()
)

bs_create_record(collection = 'app.bsky.feed.like', record = like)

Get current time in Bluesky format

Description

Get current time in Bluesky format

Usage

bs_created_at()
bs_created_at()

Value

a length 1 character vector

Function introduced

v0.1.0 (2023-11-25)

Examples

bs_created_at()
bs_created_at()

Delete a record in a repo

Description

Delete a record in a repo

Usage

bs_delete_record(
  collection,
  rkey,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass)
)
bs_delete_record(
  collection,
  rkey,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass)
)

Arguments

`collection`	Character, length 1. The NSID of the record collection.
`rkey`	Character, length 1. The CID of the version of the record. If not specified, then return the most recent version.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.

Value

an httr2 status code

Lexicon references

repo/deleteRecord.json (2023-11-25)

Function introduced

v0.1.0 (2023-11-25)

Examples


# get info about a record
post_rcd <- bs_get_record('https://bsky.app/profile/bskyr.bsky.social/post/3kf2577exva2x')
# create a record, to like the post
like <- list(
  subject = list(
    uri = post_rcd$uri,
    cid = post_rcd$cid
  ),
  createdAt = bs_created_at()
)

rec <- bs_create_record(collection = 'app.bsky.feed.like', record = like)
bs_delete_record(
  collection = 'app.bsky.feed.like',
  rkey = stringr::str_split_i(rec$uri, '/', i = 5)
)

# get info about a record
post_rcd <- bs_get_record('https://bsky.app/profile/bskyr.bsky.social/post/3kf2577exva2x')
# create a record, to like the post
like <- list(
  subject = list(
    uri = post_rcd$uri,
    cid = post_rcd$cid
  ),
  createdAt = bs_created_at()
)

rec <- bs_create_record(collection = 'app.bsky.feed.like', record = like)
bs_delete_record(
  collection = 'app.bsky.feed.like',
  rkey = stringr::str_split_i(rec$uri, '/', i = 5)
)

Describe a repo

Description

Describe a repo

Usage

bs_describe_repo(
  repo,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_describe_repo(
  repo,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`repo`	Character, length 1. The handle or DID of the repo.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of record information

Lexicon references

repo/describeRepo.json (2023-11-25)

Function introduced

v0.1.0 (2023-11-25)

Examples


bs_describe_repo('chriskenny.bsky.social')

bs_describe_repo('chriskenny.bsky.social')

Get a list of lists that belong to an actor.

Description

Get a list of lists that belong to an actor.

Usage

bs_get_actor_lists(
  actor,
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_actor_lists(
  actor,
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`actor`	Character, length 1. name of 1 actor, such as `'chriskenny.bsky.social'`
`cursor`	Character, length 1. A cursor property from a prior response. Default: `NULL`.
`limit`	Integer. Number of records to request. If over `100`, multiple requests are made.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of lists

Lexicon references

graph/getLists.json (2023-10-02)

Function introduced

v0.0.1 (2023-10-02)

Examples


bs_get_actor_lists('profmusgrave.bsky.social')

bs_get_actor_lists('profmusgrave.bsky.social')

Get a list of actors suggested for following

Description

Get a list of actors suggested for following

Usage

bs_get_actor_suggestions(
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_actor_suggestions(
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`cursor`	Character, length 1. A cursor property from a prior response. Default: `NULL`.
`limit`	Integer. Number of records to request. If over `100`, multiple requests are made.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of suggested accounts to follow

Lexicon references

actor/getSuggestions.json (2023-10-01)

Function introduced

v0.0.1 (2023-10-01)

Examples


bs_get_actor_suggestions()

bs_get_actor_suggestions()

Retrieve posts on an actor's feed

Description

Retrieve posts on an actor's feed

Usage

bs_get_author_feed(
  actor,
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_author_feed(
  actor,
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`actor`	Character, length 1. name of 1 actor, such as `'chriskenny.bsky.social'`
`cursor`	Character, length 1. A cursor property from a prior response. Default: `NULL`.
`limit`	Integer. Number of records to request. If over `100`, multiple requests are made.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of posts

Lexicon references

feed/getAuthorFeed.json (2023-10-01)

Function introduced

v0.0.1 (2023-10-01)

Examples


bs_get_author_feed('chriskenny.bsky.social')

bs_get_author_feed('chriskenny.bsky.social')

Retrieve a user's (self) muted lists

Description

Retrieve a user's (self) muted lists

Usage

bs_get_blocked_lists(
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_blocked_lists(
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`cursor`	Character, length 1. A cursor property from a prior response. Default: `NULL`.
`limit`	Integer. Maximum number to request.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of actors

Lexicon references

graph/getListMutes.json (2023-10-02)

Function introduced

v0.0.1 (2023-10-02)

Examples


bs_get_blocked_lists()

bs_get_blocked_lists()

Retrieve user (self) blocks

Description

Retrieve user (self) blocks

Usage

bs_get_blocks(
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_blocks(
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`cursor`	Character, length 1. A cursor property from a prior response. Default: `NULL`.
`limit`	Integer. Number of records to request. If over `100`, multiple requests are made.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of blocked accounts

Lexicon references

graph/getBlocks.json (2023-10-02)

Function introduced

v0.0.1 (2023-10-02)

Examples


bs_get_blocks()

bs_get_blocks()

Build feed from user's feed generator

Description

Build feed from user's feed generator

Usage

bs_get_feed(
  feed,
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_feed(
  feed,
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`feed`	Character, length 1. Feed to get.
`cursor`	Character, length 1. A cursor property from a prior response. Default: `NULL`.
`limit`	Integer. Number of records to request. If over `100`, multiple requests are made.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of posts

Lexicon references

feed/getFeed.json (2023-10-01)

Function introduced

v0.0.1 (2023-10-01)

Examples


bs_get_feed('at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.feed.generator/bsky-team')

bs_get_feed('at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.feed.generator/bsky-team')

Get specific information about one feed generator

Description

Get specific information about one feed generator

Usage

bs_get_feed_generator(
  feed,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_feed_generator(
  feed,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`feed`	Character, length 1. Feed to get.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of feeds

Lexicon references

feed/getFeedGenerator.json (2023-10-01)

Function introduced

v0.0.1 (2023-10-01)

Examples


bs_get_feed_generator('at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.feed.generator/bsky-team')

bs_get_feed_generator('at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.feed.generator/bsky-team')

Get information about a list of feed generators

Description

Get information about a list of feed generators

Usage

bs_get_feed_generators(
  feeds,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_feed_generators(
  feeds,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`feeds`	Character. Vector of feeds to get.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of feeds

Lexicon references

feed/getFeedGenerators.json (2023-10-01)

Function introduced

v0.0.1 (2023-10-01)

Examples


bs_get_feed_generators('at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.feed.generator/bsky-team')
bs_get_feed_generators(c(
  'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.feed.generator/bsky-team',
  'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.feed.generator/whats-hot'
))

bs_get_feed_generators('at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.feed.generator/bsky-team')
bs_get_feed_generators(c(
  'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.feed.generator/bsky-team',
  'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.feed.generator/whats-hot'
))

Get a list of feed suggestions

Description

Get a list of feed suggestions

Usage

bs_get_feed_suggestions(
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_feed_suggestions(
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`cursor`	Character, length 1. A cursor property from a prior response. Default: `NULL`.
`limit`	Integer. Number of records to request. If over `100`, multiple requests are made.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of suggested feeds

Lexicon references

Function introduced

v0.0.1 (2023-10-02)

Examples


bs_get_feed_suggestions()

bs_get_feed_suggestions()

Retrieve a list of feeds created by a given actor

Description

Retrieve a list of feeds created by a given actor

Usage

bs_get_feeds(
  actor,
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_feeds(
  actor,
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`actor`	Character, length 1. name of 1 actor, such as `'chriskenny.bsky.social'`
`cursor`	Character, length 1. A cursor property from a prior response. Default: `NULL`.
`limit`	Integer. Number of records to request. If over `100`, multiple requests are made.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of feeds

Lexicon references

feed/getActorFeeds.json (2023-10-01)

Function introduced

v0.0.1 (2023-10-01)

Examples


bs_get_feeds('chriskenny.bsky.social')

bs_get_feeds('chriskenny.bsky.social')

Get suggested follows related to a given actor

Description

Get suggested follows related to a given actor

Usage

bs_get_follow_suggestions(
  actor,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_follow_suggestions(
  actor,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`actor`	Character, length 1. name of 1 actor, such as `'chriskenny.bsky.social'`
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of actors

Lexicon references

Function introduced

v0.0.1 (2023-10-02)

Examples


bs_get_follow_suggestions('chriskenny.bsky.social')

bs_get_follow_suggestions('chriskenny.bsky.social')

Retrieve an actor's followers

Description

Retrieve an actor's followers

Usage

bs_get_followers(
  actor,
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_followers(
  actor,
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`actor`	Character, length 1. name of 1 actor, such as `'chriskenny.bsky.social'`
`cursor`	Character, length 1. A cursor property from a prior response. Default: `NULL`.
`limit`	Integer. Number of records to request. If over `100`, multiple requests are made.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of actors

Lexicon references

graph/getFollowers.json (2023-10-02)

Function introduced

v0.0.1 (2023-10-02)

Examples


bs_get_followers('chriskenny.bsky.social')

bs_get_followers('chriskenny.bsky.social')

Retrieve an actor's follows

Description

Retrieve an actor's follows

Usage

bs_get_follows(
  actor,
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_follows(
  actor,
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`actor`	Character, length 1. name of 1 actor, such as `'chriskenny.bsky.social'`
`cursor`	Character, length 1. A cursor property from a prior response. Default: `NULL`.
`limit`	Integer. Number of records to request. If over `100`, multiple requests are made.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of actors

Lexicon references

graph/getFollows.json (2023-10-02)

Function introduced

v0.0.1 (2023-10-02)

Examples


bs_get_follows('chriskenny.bsky.social')

bs_get_follows('chriskenny.bsky.social')

Retrieve posts liked by an actor

Description

Retrieve posts liked by an actor

Usage

bs_get_likes(
  actor,
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_likes(
  actor,
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`actor`	Character, length 1. name of 1 actor, such as `'chriskenny.bsky.social'`
`cursor`	Character, length 1. A cursor property from a prior response. Default: `NULL`.
`limit`	Integer. Number of records to request. If over `100`, multiple requests are made.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of likes

Lexicon references

feed/getActorLikes.json (2023-10-01)

Function introduced

v0.0.1 (2023-10-01)

Examples


bs_get_likes('chriskenny.bsky.social')

bs_get_likes('chriskenny.bsky.social')

Retrieve a user's (self) muted lists

Description

Retrieve a user's (self) muted lists

Usage

bs_get_muted_lists(
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_muted_lists(
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of actors

Lexicon references

graph/getListMutes.json (2023-10-02)

Function introduced

v0.0.1 (2023-10-02)

Examples


bs_get_muted_lists()

bs_get_muted_lists()

Retrieve a user's (self) muted accounts

Description

Retrieve a user's (self) muted accounts

Usage

bs_get_mutes(
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_mutes(
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`cursor`	Character, length 1. A cursor property from a prior response. Default: `NULL`.
`limit`	Integer. Number of records to request. If over `100`, multiple requests are made.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of actors

Lexicon references

graph/getMutes.json (2023-10-02)

Function introduced

v0.0.1 (2023-10-02)

Examples


bs_get_mutes()

bs_get_mutes()

Get the user's (self) number of unread notifications

Description

Get the user's (self) number of unread notifications

Usage

bs_get_notification_count(
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_notification_count(
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble with a single column and row for the count

Lexicon references

notification/getUnreadCount.json (2023-10-02)

Function introduced

v0.0.1 (2023-10-02)

Examples


bs_get_notification_count()

bs_get_notification_count()

Get the user's (self) notifications

Description

Get the user's (self) notifications

Usage

bs_get_notifications(
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_notifications(
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`cursor`	Character, length 1. A cursor property from a prior response. Default: `NULL`.
`limit`	Integer. Number of records to request. If over `100`, multiple requests are made.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble with notifications

Lexicon references

notification/listNotifications.json (2023-10-02)

Function introduced

v0.0.1 (2023-10-02)

Examples


bs_get_notifications()

bs_get_notifications()

Retrieve likes on a post

Description

Retrieve likes on a post

Usage

bs_get_post_likes(
  uri,
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_post_likes(
  uri,
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`uri`	Character, length 1. URI for post to get.
`cursor`	Character, length 1. A cursor property from a prior response. Default: `NULL`.
`limit`	Integer. Number of records to request. If over `100`, multiple requests are made.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of likes

Lexicon references

feed/getLikes.json (2023-10-01)

Function introduced

v0.0.1 (2023-10-01)

Examples


bs_get_post_likes('at://did:plc:ic6zqvuw5ulmfpjiwnhsr2ns/app.bsky.feed.post/3k7qmjev5lr2s')

bs_get_post_likes('at://did:plc:ic6zqvuw5ulmfpjiwnhsr2ns/app.bsky.feed.post/3k7qmjev5lr2s')

Retrieve thread of posts

Description

Retrieve thread of posts

Usage

bs_get_post_thread(
  uri,
  depth = NULL,
  parent_height = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_post_thread(
  uri,
  depth = NULL,
  parent_height = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`uri`	Character, length 1. URI for post to get.
`depth`	Integer. Maximum depth to request. Maximum: `1000`
`parent_height`	Integer. Maximum parent height to request.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of posts

Lexicon references

feed/getPostThread.json (2023-10-01)

Function introduced

v0.0.1 (2023-10-01)

Examples


bs_get_post_thread('at://did:plc:ic6zqvuw5ulmfpjiwnhsr2ns/app.bsky.feed.post/3k7qmjev5lr2s')

bs_get_post_thread('at://did:plc:ic6zqvuw5ulmfpjiwnhsr2ns/app.bsky.feed.post/3k7qmjev5lr2s')

Retrieve thread of posts

Description

Retrieve thread of posts

Usage

bs_get_posts(
  uris,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_posts(
  uris,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`uris`	Character. Vector of URIs for posts to get.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of posts

Lexicon references

feed/getPostThread.json (2023-10-01)

Function introduced

v0.0.1 (2023-10-01)

Examples


bs_get_posts('at://did:plc:ic6zqvuw5ulmfpjiwnhsr2ns/app.bsky.feed.post/3k7qmjev5lr2s')

bs_get_posts('at://did:plc:ic6zqvuw5ulmfpjiwnhsr2ns/app.bsky.feed.post/3k7qmjev5lr2s')

Get (Self) Preferences

Description

Get (Self) Preferences

Usage

bs_get_preferences(
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_preferences(
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of preferences

Lexicon references

actor/getPreferences.json (2023-10-01)

Function introduced

v0.0.1 (2023-10-01)

Examples


bs_get_preferences()

bs_get_preferences()

Get Profile for a Bluesky Social User

Description

Get Profile for a Bluesky Social User

Usage

bs_get_profile(
  actors,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_profile(
  actors,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`actors`	character vector of actor(s), such as `'chriskenny.bsky.social'`
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble with a row for each actor

Lexicon references

actor/getProfiles.json (2023-10-01) actor/getProfile.json (2023-10-01)

Function introduced

v0.0.1 (2023-10-01)

Examples


bs_get_profile('chriskenny.bsky.social')
bs_get_profile(actors = c('chriskenny.bsky.social', 'simko.bsky.social'))

bs_get_profile('chriskenny.bsky.social')
bs_get_profile(actors = c('chriskenny.bsky.social', 'simko.bsky.social'))

Get an arbitrary record from a repo

Description

Get an arbitrary record from a repo

Usage

bs_get_record(
  repo = NULL,
  collection = NULL,
  rkey = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_record(
  repo = NULL,
  collection = NULL,
  rkey = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`repo`	Character, length 1. The handle or DID of the repo.
`collection`	Character, length 1. The NSID of the record collection.
`rkey`	Character, length 1. The CID of the version of the record. If not specified, then return the most recent version.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of upload blob information

Lexicon references

repo/getRecord.json (2023-11-24)

Function introduced

v0.1.0 (2023-11-24)

Examples


bs_get_record('https://bsky.app/profile/bskyr.bsky.social/post/3kf2577exva2x')

bs_get_record('https://bsky.app/profile/bskyr.bsky.social/post/3kf2577exva2x')

Retrieve actors who reposted a post

Description

Retrieve actors who reposted a post

Usage

bs_get_reposts(
  uri,
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_reposts(
  uri,
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`uri`	Character, length 1. URI for post to get.
`cursor`	Character, length 1. A cursor property from a prior response. Default: `NULL`.
`limit`	Integer. Number of records to request. If over `100`, multiple requests are made.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of actors

Lexicon references

feed/getRepostedBy.json (2023-10-01)

Function introduced

v0.0.1 (2023-10-02)

Examples


bs_get_reposts('at://did:plc:ic6zqvuw5ulmfpjiwnhsr2ns/app.bsky.feed.post/3kaa2gxjhzr2a')

bs_get_reposts('at://did:plc:ic6zqvuw5ulmfpjiwnhsr2ns/app.bsky.feed.post/3kaa2gxjhzr2a')

Retrieve the user's home timeline

Description

Retrieve the user's home timeline

Usage

bs_get_timeline(
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_get_timeline(
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`cursor`	Character, length 1. A cursor property from a prior response. Default: `NULL`.
`limit`	Integer. Number of records to request. If over `100`, multiple requests are made.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of posts

Lexicon references

feed/getTimeline.json (2023-10-01)

Function introduced

v0.0.1 (2023-10-02)

Examples


bs_get_timeline()

bs_get_timeline()

Like an existing post

Description

Like an existing post

Usage

bs_like(
  post,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_like(
  post,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`post`	Character vector, length 1. Link to a post.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of post information

Lexicon references

feed/like.json (2023-11-25) repo/createRecord.json (2023-11-25)

Function introduced

v0.1.0 (2023-11-25)

Examples


bs_like(post = 'https://bsky.app/profile/bskyr.bsky.social/post/3kf2577exva2x')

bs_like(post = 'https://bsky.app/profile/bskyr.bsky.social/post/3kf2577exva2x')

List records in a repo

Description

List records in a repo

Usage

bs_list_records(
  repo,
  collection,
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_list_records(
  repo,
  collection,
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`repo`	Character, length 1. The handle or DID of the repo.
`collection`	Character, length 1. The NSID of the record collection.
`cursor`	Character, length 1. A cursor property from a prior response. Default: `NULL`.
`limit`	Integer. Number of records to request. If over `100`, multiple requests are made.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of record information

Lexicon references

repo/createRecord.json (2023-11-25)

Function introduced

v0.1.0 (2023-11-25)

Examples


bs_list_records(repo = 'chriskenny.bsky.social', collection = 'app.bsky.feed.post')

bs_list_records(repo = 'chriskenny.bsky.social', collection = 'app.bsky.feed.post')

Make a post on Bluesky Social

Description

Make a post on Bluesky Social

Usage

bs_post(
  text,
  images,
  images_alt,
  langs,
  reply,
  quote,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_post(
  text,
  images,
  images_alt,
  langs,
  reply,
  quote,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`text`	text of post
`images`	character vector of paths to images to attach to post
`images_alt`	character vector of alt text for images. Must be same length as `images` if used.
`langs`	character vector of languages in BCP-47 format
`reply`	character vector with link to the parent post to reply to
`quote`	character vector with link to a post to quote
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of post information

Lexicon references

feed/post.json (2023-10-02) repo/createRecord.json (2023-10-02)

Function introduced

v0.0.1 (2023-10-02)

Examples


bs_post('Test post from R CMD Check for r package `bskyr`
via @bskyr.bsky.social (https://christophertkenny.com/bskyr/)')
bs_post('Test self-reply from r package `bskyr`
via @bskyr.bsky.social (https://christophertkenny.com/bskyr/)',
  reply = 'https://bsky.app/profile/bskyr.bsky.social/post/3kexwuoyqj32g'
)
bs_post('Test quoting from r package `bskyr`
via @bskyr.bsky.social (https://christophertkenny.com/bskyr/)',
  quote = 'https://bsky.app/profile/bskyr.bsky.social/post/3kf24wd6cmb2a'
)
bs_post('Test quote and reply from r package `bskyr`
via @bskyr.bsky.social (https://christophertkenny.com/bskyr/)',
  reply = 'https://bsky.app/profile/bskyr.bsky.social/post/3kexwuoyqj32g',
  quote = 'https://bsky.app/profile/bskyr.bsky.social/post/3kf24wd6cmb2a'
)

bs_post('Test post from R CMD Check for r package `bskyr`
via @bskyr.bsky.social (https://christophertkenny.com/bskyr/)')
bs_post('Test self-reply from r package `bskyr`
via @bskyr.bsky.social (https://christophertkenny.com/bskyr/)',
  reply = 'https://bsky.app/profile/bskyr.bsky.social/post/3kexwuoyqj32g'
)
bs_post('Test quoting from r package `bskyr`
via @bskyr.bsky.social (https://christophertkenny.com/bskyr/)',
  quote = 'https://bsky.app/profile/bskyr.bsky.social/post/3kf24wd6cmb2a'
)
bs_post('Test quote and reply from r package `bskyr`
via @bskyr.bsky.social (https://christophertkenny.com/bskyr/)',
  reply = 'https://bsky.app/profile/bskyr.bsky.social/post/3kexwuoyqj32g',
  quote = 'https://bsky.app/profile/bskyr.bsky.social/post/3kf24wd6cmb2a'
)

Repost an existing post

Description

Repost an existing post

Usage

bs_repost(
  post,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_repost(
  post,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`post`	Character vector, length 1. Link to a post.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of post information

Lexicon references

feed/post.json (2023-11-25) repo/createRecord.json (2023-11-25)

Function introduced

v0.1.0 (2023-11-25)

Examples


bs_repost('https://bsky.app/profile/bskyr.bsky.social/post/3kf2577exva2x')

bs_repost('https://bsky.app/profile/bskyr.bsky.social/post/3kf2577exva2x')

Resolve a Handle to Decentralized Identifier (DID)

Description

Resolve a Handle to Decentralized Identifier (DID)

Usage

bs_resolve_handle(
  handle,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_resolve_handle(
  handle,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`handle`	Character, length 1. Handle, such as `'chriskenny.bsky.social'`
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of decentralized identifier

Lexicon references

identity/resolveHandle.json (2023-11-24)

Function introduced

v0.1.0 (2023-11-24)

Examples


bs_resolve_handle('chriskenny.bsky.social')

bs_resolve_handle('chriskenny.bsky.social')

Find profiles matching search criteria

Description

Find profiles matching search criteria

Usage

bs_search_actors(
  query,
  typeahead = FALSE,
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_search_actors(
  query,
  typeahead = FALSE,
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`query`	character. search query, Lucene query syntax is recommended when `typeahead = FALSE`.
`typeahead`	logical. Use typeahead for search? Default is `FALSE`.
`cursor`	Character, length 1. A cursor property from a prior response. Default: `NULL`.
`limit`	Integer. Number of records to request. If over `100`, multiple requests are made.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of suggested accounts to follow

Lexicon references

actor/searchActors.json (2023-10-01) actor/searchActorsTypeahead.json (2023-10-01)

Function introduced

v0.0.1 (2023-10-01)

Examples


bs_search_actors('political science')

bs_search_actors('political science')

Find posts matching search criteria

Description

Find posts matching search criteria

Usage

bs_search_posts(
  query,
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_search_posts(
  query,
  cursor = NULL,
  limit = NULL,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`query`	character. search query, Lucene query syntax is recommended.
`cursor`	Character, length 1. A cursor property from a prior response. Default: `NULL`.
`limit`	Integer. Number of records to request. If over `100`, multiple requests are made.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of suggested accounts to follow

Lexicon references

feed/searchPosts.json (2023-12-13)

Function introduced

v0.1.1 (2023-12-13)

Examples


bs_search_posts('redistricting')

bs_search_posts('redistricting')

Upload a blob to a repo

Description

Upload a blob to a repo

Usage

bs_upload_blob(
  blob,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)
bs_upload_blob(
  blob,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

`blob`	Character, files to upload to a repo.
`user`	Character. User name to log in with. Defaults to `get_bluesky_user()`.
`pass`	Character. App password to log in with. Defaults to `get_bluesky_pass()`.
`auth`	Authentication information. Defaults to `bs_auth(user, pass)`.
`clean`	Logical. Should output be cleaned into a `tibble`? Default: `TRUE`.

Value

a tibble::tibble of upload blob information

Lexicon references

repo/uploadBlob.json (2023-11-24)

Function introduced

v0.1.0 (2023-11-24)

Examples


fig <- fs::path_package('bskyr', 'man/figures/logo.png')
bs_upload_blob(fig)

fig <- fs::path_package('bskyr', 'man/figures/logo.png')
bs_upload_blob(fig)

Convert Universal Resource Identifiers to Hypertext Transfer Protocol Secure URLs

Description

Convert Universal Resource Identifiers to Hypertext Transfer Protocol Secure URLs

Usage

bs_uri_to_url(uri)
bs_uri_to_url(uri)

Arguments

uri

Character, length 1. URI for post to get.

Value

character vector of HTTPS URLs

Examples

bs_uri_to_url('at://did:plc:ic6zqvuw5ulmfpjiwnhsr2ns/app.bsky.feed.post/3k7qmjev5lr2s')
bs_uri_to_url('at://did:plc:ic6zqvuw5ulmfpjiwnhsr2ns/app.bsky.feed.post/3k7qmjev5lr2s')

Check or Get Bluesky App Password

Description

Check or Get Bluesky App Password

Usage

has_bluesky_pass()

get_bluesky_pass()

bs_get_pass()

bs_has_pass()
has_bluesky_pass()

get_bluesky_pass()

bs_get_pass()

bs_has_pass()

Value

logical if has, pass if get

Examples

has_bluesky_pass()
has_bluesky_pass()

Add Entry to Renviron

Description

Adds Bluesky App Password to .Renviron.

Usage

set_bluesky_pass(pass, overwrite = FALSE, install = FALSE, r_env = NULL)

bs_set_pass(pass, overwrite = FALSE, install = FALSE, r_env = NULL)
set_bluesky_pass(pass, overwrite = FALSE, install = FALSE, r_env = NULL)

bs_set_pass(pass, overwrite = FALSE, install = FALSE, r_env = NULL)

Arguments

`pass`	Character. App Password to add to add.
`overwrite`	Defaults to FALSE. Boolean. Should existing `BLUESKY_APP_PASS` in Renviron be overwritten?
`install`	Defaults to FALSE. Boolean. Should this be added '~/.Renviron' file?
`r_env`	Path to install to if `install` is `TRUE`.

Value

pass, invisibly

Examples

example_env <- tempfile(fileext = '.Renviron')
set_bluesky_pass('1234-1234-1234-1234', r_env = example_env)
# r_env should likely be: file.path(Sys.getenv('HOME'), '.Renviron')
example_env <- tempfile(fileext = '.Renviron')
set_bluesky_pass('1234-1234-1234-1234', r_env = example_env)
# r_env should likely be: file.path(Sys.getenv('HOME'), '.Renviron')

Adds Bluesky User to .Renviron.

Description

Adds Bluesky User to .Renviron.

Usage

set_bluesky_user(user, overwrite = FALSE, install = FALSE, r_env = NULL)

bs_set_user(user, overwrite = FALSE, install = FALSE, r_env = NULL)
set_bluesky_user(user, overwrite = FALSE, install = FALSE, r_env = NULL)

bs_set_user(user, overwrite = FALSE, install = FALSE, r_env = NULL)

Arguments

`user`	Character. User to add to add.
`overwrite`	Defaults to FALSE. Boolean. Should existing `BLUESKY_APP_USER` in Renviron be overwritten?
`install`	Defaults to FALSE. Boolean. Should this be added '~/.Renviron' file?
`r_env`	Path to install to if `install` is `TRUE`.

Value

user, invisibly

Examples

example_env <- tempfile(fileext = '.Renviron')
set_bluesky_user('CRAN_EXAMPLE.bsky.social', r_env = example_env)
# r_env should likely be: file.path(Sys.getenv('HOME'), '.Renviron')
example_env <- tempfile(fileext = '.Renviron')
set_bluesky_user('CRAN_EXAMPLE.bsky.social', r_env = example_env)
# r_env should likely be: file.path(Sys.getenv('HOME'), '.Renviron')

Check or Get Bluesky User

Description

Check or Get Bluesky User

Usage

has_bluesky_user()

get_bluesky_user()

bs_get_user()

bs_has_user()
has_bluesky_user()

get_bluesky_user()

bs_get_user()

bs_has_user()

Value

logical if has, user if get

Examples

has_bluesky_user()
has_bluesky_user()

Package 'bskyr'

Help Index

Authenticate a user

Description

Usage

Arguments

Value

Lexicon references

Function introduced

Examples

Create a record in a repo

Description

Usage

Arguments

Value

Lexicon references

Function introduced

Examples

Get current time in Bluesky format

Description

Usage

Value

Function introduced

Examples

Delete a record in a repo

Description

Usage

Arguments

Value

Lexicon references

Function introduced

Examples

Describe a repo

Description

Usage

Arguments

Value

Lexicon references

Function introduced

Examples

Get a list of lists that belong to an actor.

Description

Usage

Arguments

Value

Lexicon references

Function introduced

Examples

Get a list of actors suggested for following

Description

Usage

Arguments

Value

Lexicon references

Function introduced

Examples

Retrieve posts on an actor's feed

Description

Usage

Arguments

Value

Lexicon references

Function introduced

Examples

Retrieve a user's (self) muted lists

Description

Usage

Arguments

Value

Lexicon references

Function introduced

Examples

Retrieve user (self) blocks

Description

Usage

Arguments

Value

Lexicon references

Function introduced

Examples