account_breaches: Search for data breaches associated with one or more...

View source: R/account_breaches.R

account_breachesR Documentation

Search for data breaches associated with one or more accounts.

Description

Search for data breaches associated with one or more accounts.

Usage

account_breaches(accounts, truncate = FALSE, domain = NULL,
  as_list = TRUE, verbose = TRUE, agent = NULL)

Arguments

accounts

A character vector of email addresses or account names

truncate

Whether responses should be trimmed to just name of breached site

domain

Search a specific domain

as_list

whether to return results as a list (default, TRUE) or a data.frame, When returned as a data.frame only accounts with at least one breach are returned.

verbose

whether to message about http errors and re-tries

agent

agent to be used as header in calls, by default "HIBPwned R pkg". # nolint

Details

Note that the package uses memoise (https://github.com/r-lib/memoise) with no timeout argument so that results are cached inside an active R session.

Value

List of data.frames containing results

Examples

account_breaches(c("steff.sullivan@gmail.com","stephanie.g.locke@gmail.com"))

lockedata/HIBPwned documentation built on Oct. 15, 2022, 12:19 a.m.