Skip to contents

Set the IUCN Red List API key

Source: R/rl_set_api.R
rl_set_api.Rd

This function sets the IUCN Red List API key as an environment variable, allowing other functions in the package to authenticate requests to the IUCN Red List API.

Usage

rl_set_api(api_key)

Arguments

api_key

Character. The API key provided by the IUCN Red List to authenticate requests. You can obtain an API key by registering on the IUCN Red List website https://api.iucnredlist.org/users/sign_in.

Details

The IUCN Red List API requires an API key to access data. This function sets the provided api_key as an environment variable named redlist_api. This environment variable is accessed by other functions in the package to perform authenticated API requests.

Examples

if (FALSE) { # \dontrun{
  # Set the API key for the IUCN Red List
  rl_set_api("your_api_key_here")
} # }