Skip to contents

Generate a base request object for the onezoom database

Source: R/oz_basereq.R
oz_basereq.Rd

This request is used as the basis for all calls to the onezoom API. It does not contain any tokens or session ids, and thus can be regenerated at any time.

Usage

oz_basereq(
  baseurl = "https://www.onezoom.org/",
  useragent = "ROZ",
  unsafe = FALSE
)

Arguments

baseurl

the base url for the onezoom API.

useragent

the user agent string used when contacting onezoom.

unsafe

disable ssl verification (should only ever be required on Linux, do not enable this by default).

Value

Returns an httr2 request object, pointing at baseurl using useragent

Author

Francis Windram

Examples

if (FALSE) { # \dontrun{
basereq <- oz_basereq(
  baseurl="https://www.onezoom.org/",
  useragent="ROZ")
} # }