bs_search_actors {bskyr}R Documentation

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
)

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


[Package bskyr version 0.1.2 Index]