get_fmr: Load Fair Market Rents from the HUD API

In CenterOnBudget/hudapi: Load Data From the HUD API Into R

Description

get_fmr() loads Fair Market Rents for counties or metro areas within a given state from the HUD API.

Usage

get_fmr(
  geography,
  state,
  year,
  token = get_token(),
  drop_empty_cols = TRUE,
  tibble = TRUE,
  show_url = FALSE
)

Arguments

geography	Geography of data to pull. One of "county" or "metro".
state	State to pull data for. Specify as a two-letter state abbreviation. The 50 states plus DC, AS, GU, MP, PR, and VI are supported.
year	Year to pull data for. Currently, years 2017 to 2020 are supported.
token	HUD API access token. Defaults to environment variable HUD_API_TOKEN.
drop_empty_cols	If TRUE (default), drop empty columns in returned data.
tibble	If TRUE (default), return data as a tibble. Otherwise, return data as a base data frame.
show_url	If TRUE, show URL the request was sent to. Defaults to FALSE.

Value

A tibble or base data frame with requested data.

CenterOnBudget/hudapi documentation built on July 6, 2021, 2:53 p.m.