set_api_key: Set API Key

View source: R/auth.R

set_api_keyR Documentation

Set API Key

Description

Configure your Nomis API key for increased rate limits. Register at: https://www.nomisweb.co.uk/myaccount/userjoin.asp

Usage

set_api_key(key = NULL, persist = FALSE)

Arguments

key

API key string. If NULL, will prompt or check environment.

persist

If TRUE, saves to .Renviron for future sessions.

Value

Invisible TRUE if successful

Examples


set_api_key("your-key-here")
set_api_key("your-key-here", persist = TRUE)


nomisdata documentation built on Feb. 10, 2026, 5:10 p.m.