Skip to contents

Check OpenAlex rate limit status

Source: R/pro_rate_limit_status.R
pro_rate_limit_status.Rd

Queries the OpenAlex rate-limit endpoint and returns current API usage and remaining budget as a parsed list.

Usage

pro_rate_limit_status(
  api_key = Sys.getenv("openalexPro.apikey"),
  verbose = TRUE
)

Arguments

api_key

API key (character string) or `NULL`. Defaults to Sys.getenv("openalexPro.apikey"). If `NULL` or `""`, this function returns FALSE with an informational message.

verbose

Logical. If TRUE (default), prints rate limit info via message().

Value

Invisibly, the parsed JSON list with all rate limit fields; FALSE if the API key is missing or invalid; or NULL if the request failed due to a network error.