Skip to contents

Install an AEMET API key

Source: R/aemet-api-key.R
aemet_api_key.Rd

This function will store your AEMET API key on your local machine so it can be called securely without being stored in your code.

Alternatively, you can install the API key manually:

  • Run Sys.setenv(AEMET_API_KEY = "Your_Key"). You will need to run this command in each session (similar to install = FALSE).

  • Write this line in your .Renviron file: AEMET_API_KEY = "Your_Key" (same behavior as install = TRUE). This stores your API key permanently.

Usage

aemet_api_key(apikey, overwrite = FALSE, install = FALSE)

Arguments

apikey

The AEMET API key formatted in quotes. A key can be acquired at https://opendata.aemet.es/centrodedescargas/inicio. You can install several API keys as a character vector, see Details.

overwrite

If TRUE, overwrites an existing AEMET_API_KEY already set on your local machine.

install

If TRUE, installs the key on your local machine for use in future sessions. Defaults to FALSE.

Value

Invisibly returns NULL.

Details

You can pass several apikey values as a character vector c(api1, api2), in this case, multiple AEMET_API_KEY values are generated. In each subsequent API call, climaemet chooses the API key with the highest remaining quota.

This is useful when performing batch queries to avoid API throttling.

Note

To locate your API key on your local machine, run rappdirs::user_cache_dir("climaemet", "R").

See also

Other aemet_auth: aemet_detect_api_key()

Examples

# Do not run these examples.

if (FALSE) {
  aemet_api_key("111111abc", install = TRUE)

  # Check it with:
  Sys.getenv("AEMET_API_KEY")
}

if (FALSE) {
  # Overwrite an existing key:
  aemet_api_key("222222abc", overwrite = TRUE, install = TRUE)

  # Check it with:
  Sys.getenv("AEMET_API_KEY")
}