Package: hudpy
hudpyAre you a R developer? Check outrhudinsteadInstallationTo install from pypi usepip install hudpyYou can install the development version by cloning the repositorygit clone https://github.com/etam4260/hudpy.gitnow runpip install ./hudpyKey AccessTo use functions provided by this package, you need to get access HUD
USER via token. Go tohttps://www.huduser.gov/hudapi/public/loginto
register for an account and then create a token with access to all
datasets provided by HUD. This will include selecting USPS Crosswalk,
Fair Markets Rent, Income Limits, and Comprehensive Housing
Affordability Strategy.Now copy and paste that key into the hud_set_key() function.hud_set_key("sample-key")Simplistic ExampleThis sample provided below shows how to query the USPS Crosswalk APIhud_cw_zip_tract(zip = '35213', year = ['2010'], quarter = ['1'])Housing and Urban Development in PythonThis interface uses the HUD User Data API but is not endorsed or
certified by HUD User.The goal of this project is to provide an easy-to-use interface to
access various open-source APIs provided by the U.S Housing and Urban
Development. These include the USPS Crosswalk Files, Fair Markets Rent,
Income Limits, and Comprehensive Housing and Affordability Strategy.
Although HUD does provide datasets for other programs, they are
currently not supported by an API.Please readhttps://www.huduser.gov/portal/dataset/api-terms-of-service.htmlfor
all terms of service.According to HUD USER:All services, which utilize or access the API, should display the
following notice prominently within the application: “This product uses
the HUD User Data API but is not endorsed or certified by HUD User.” You
may use the HUD User name in order to identify the source of API content
subject to these rules. You may not use the HUD User name, or the like
to imply endorsement of any product, service, or entity, not-for-profit,
commercial or otherwise.HUD User:https://www.huduser.gov/portal/datasetsAccording to (HUD User Home Page | HUD USER), HUD User is a U.S.
Department of Housing and Urban Development information source that
includes reports and reference documents. HUD USER was founded in 1978
by the Department of Housing and Urban Development’s Office of Policy
Development and Research.HUD User maintains an API to gain access to their data. However, their
API system can be confusing and provides their information in JSON
format rather than a data-frame like object. Although there exist file
downloadables, R users may want to be able to extract specific bits of
the data into memory.CitationPlease cite this package using:Tam E, Reilly A, Ghaedi H, Jin S (2022). hudpy: A Python Interface to the
HUD (US Department of Housing and Urban Development) APIs. 0.1.0.9000,https://github.com/etam4260/hudpy/.Available DataThe APIs and datasets which this library interfaces are listed below.
The HUD also provide miscellaneous supplemental APIs under them.HUD UserUSPS Crosswalk
(https://www.huduser.gov/portal/dataset/uspszip-api.html)USPS Crosswalk FilesYearshud_cw_zip_tract()2010-2021hud_cw_zip_county()2010-2021hud_cw_zip_cbsa()2010-2021hud_cw_zip_cbsadiv()2017-2021hud_cw_zip_countysub()2018-2021hud_cw_zip_cd()2010-2021hud_cw_tract_zip()2010-2021hud_cw_county_zip()2010-2021hud_cw_cbsa_zip()2010-2021hud_cw_cbsadiv_zip()2017-2021hud_cw_cd_zip()2010-2021hud_cw_countysub_zip()2018-2021hud_cw()2010-2021crosswalk()2010-2021z_in_trt()2010-2021z_in_cty()2010-2021z_in_cbsa()2010-2021z_in_cbsadiv()2017-2021z_in_ctysb()2018-2021z_in_cd()2010-2021trt_in_z()2010-2021cty_in_z()2010-2021cbsa_in_z()2010-2021cbsadiv_in_z()2017-2021ctysb_in_z()2018-2021cd_in_z()2010-2021Fair Markets Rent
(https://www.huduser.gov/portal/dataset/fmr-api.html)Small Areas Fair Markets RentFair Markets RentYearshud_fmr_state_counties()2017-2022hud_fmr_state_metroareas()2017-2022hud_fmr_county_zip()2017-2022hud_fmr_metroarea_zip()2017-2022hud_fmr()2017-2022Income Limits
(https://www.huduser.gov/portal/dataset/fmr-api.html)Income LimitsYearshud_il()2017-2022Comprehensive Housing and Affordability Strategy
(https://www.huduser.gov/portal/dataset/chas-api.html)Comprehensive Housing and Affordability StrategyYearshud_chas_nation()2014-2018 , 2013-2017, 2012-2016, 2011-2015, 2010-2014, 2009-2013, 2008-2012, 2007-2011, 2006-2010hud_chas_state()2014-2018 , 2013-2017, 2012-2016, 2011-2015, 2010-2014, 2009-2013, 2008-2012, 2007-2011, 2006-2010hud_chas_county()2014-2018 , 2013-2017, 2012-2016, 2011-2015, 2010-2014, 2009-2013, 2008-2012, 2007-2011, 2006-2010hud_chas_state_mcd()2014-2018 , 2013-2017, 2012-2016, 2011-2015, 2010-2014, 2009-2013, 2008-2012, 2007-2011, 2006-2010hud_chas_state_place()2014-2018 , 2013-2017, 2012-2016, 2011-2015, 2010-2014, 2009-2013, 2008-2012, 2007-2011, 2006-2010hud_chas()2014-2018 , 2013-2017, 2012-2016, 2011-2015, 2010-2014, 2009-2013, 2008-2012, 2007-2011, 2006-2010US Geographic EntitiesUS Geographieshud_nation_states_territories()hud_state_metropolitan()hud_state_counties()hud_state_places()hud_state_minor_civil_divisions()Key accessManagementhud_set_key()hud_get_key()hud_set_user_agent()hud_get_user_agent()CachingCachinghud_set_cache_dir()hud_get_cache_dir()hud_clear_cache()UtilitiesUtilitiesrhud_website()hud_rec_cw_yr()hud_rec_fmr_yr()hud_rec_il_yr()ContributorsEmmet Tam(https://github.com/etam4260)[emmet_tam@yahoo.com]Allison Reilly()[areilly2@umd.edu]Hamed Ghaedi()[hghaedi@terpmail.umd.edu]Shuyu Jin(https://github.com/geojsy)[geojsy@umd.edu]DisclaimersLicense: GPL >= 2This interface uses the HUD User Data API but is not endorsed or
certified by HUD User.The limit on the maximum number of API calls is 1200 queries a min.
Each function call does not correspond to a single API call!This is a WIP so please report any issues or bugs to:https://github.com/etam4260/hudpy/issuesThis is open source, so please fork and introduce some pull
requests!ReferencesHUD User Home Page: HUD USER. HUD User Home Page | HUD USER. (n.d.).
Retrieved February 24, 2022, fromhttps://www.huduser.gov/portal/home.html