searchForEntity: Function to search for some entities matching certain search...

In Lyrohk/cruncher: Crunchbase API v4.0

Description

Function to search for some entities matching certain search criteria over the Search API Endpoint

Usage

searchForEntity(
  path,
  conditions,
  order_by = "identifier",
  sort_by = "asc",
  result_limit = NA,
  uuids_only = FALSE,
  precise = TRUE,
  iter = 1000L
)

Arguments

path	The path to the entity e.g. organizations, people, etc.
result_limit	Personal set limit of result. Useful when only needing e.g. the top 50 organizations in a certain category.
uuids_only	Logical. Defaults to FALSE and after getting the uuids, it will automatically lookup more data via the entity lookup API.
precise	Logical Defaults to TRUE and returns all entries. However, during the lookup this number may change and thus run forever. To safeguard against this, set this argument to FALSE (last #iter of results will be discarded).
iter	Number of results to be returned per call iteration. Default here 1000L, max 2000L. Keep in mind that the last #iter results will be discarded if you set precise to FALSE.
search_conditions	of what you are looking for
please_parse	TRUE or FALSE. By default TRUE. If set to FALSE, it will return the data directly from the JSON, if set to TRUE, it will parse it into a data.frame object

Value

either a data.frame (if parse = TRUE) or a list (if parse = FALSE)

Author(s)

Layla Rohkohl, [e-mail]

Examples

lookupEntity("facebook", "organizations", please_parse = T)

Lyrohk/cruncher documentation built on Dec. 17, 2021, 1:17 a.m.