hudr (version 1.2.0)

get_hud_fmr_statedata: Get HUD Fair Market Rent data at the State Level from HUD.

Description

Provides fair market rent data at the State level from HUD.

Usage

get_hud_fmr_statedata(entityid, yr, hud_key = Sys.getenv("HUD_API_KEY"))

Value

A list of data tables containing fair market rent data from HUD.

Arguments

entityid

Character string containing the 'state_code' from get_hud_fmr_liststates(...).

yr

Character string indicating the year.

hud_key

Character string indicating your API key from HUD. Default is Sys.getenv("HUD_API_KEY").

Author

Paul Richardson

Details

Provides fair market rent data at the State level from HUD.

Examples

if (FALSE) {
library(hudr)

hud_key <- Sys.getenv("HUD_API_KEY")

state_codes <- get_hud_fmr_liststates(hud_key = hud_key)

fmr_state_dt <- get_hud_fmr_statedata(entityid = state_codes$state_code[1],
                                      yr = "2020",
                                      hud_key = hud_key)
}