⚠ Deprecation Notice ⚠
This project is a legacy API and is longer being actively maintained or used to serve data to consumerfinance.gov. Please use the officially supported HUD API in its place. For those interested, it may continue to serve as a model stand-alone API of HUD Housing Counseling data.
django-hud is a Django project that provides a very basic API on top of HUD Housing
Counseling data. It returns a list of
HUD approved housing counseling agencies throughout the country that can provide advice on buying a home, renting,
defaults, foreclosures, and credit issues near a given zipcode sorted by distance from it in ascending order.
|Parameter||Type||Default value||Short Description|
||integer (in miles)||5000||Distance between zipcode area centroid and counseling agency|
||integer||10||Number of results to return|
||integer||0||Number of times to skip
||string, comma separated||N/A||A list of languages either of which is spoken in agency|
||string, comma separated||N/A||A list of services either of which is provided by agency|
Data returned can be in
json (default) or
csv format. To set the format append
.csv to the zipcode
value when accessing the API.
The API can be accessed from
Return 10 closest to 20005 agencies, formatted as
Return 5 closest to the given zipcode agencies, formatted as
Return at most 10 agencies that are closer than 5 miles to 20005, formatted as
Return page 2 of the agencies that are located not further than 100 miles from 20005, 5 agencies per page,
Get the list of agencies that speak English or Korean:
Get list of agencies that provide [Mortgage Delinquency and Default Resolution Counse] or [Financial, Budgeting and Credit Repair Workshops] services:
|DRC||Mobility and Relocation Counseling|
|FHW||Fair Housing Pre-Purchase Education Workshops|
|NDW||Non-Delinquency Post Purchase Workshops|
|PPW||Pre-purchase Homebuyer Education Workshops|
|MOI||Marketing and Outreach Initiatives|
|HIC||Home Improvement and Rehabilitation Counseling|
|PLW||Predatory Lending Education Workshops|
|FBC||Financial Management/Budget Counseling|
|RHW||Rental Housing Workshops|
|DFW||Resolving/Preventing Mortgage Delinquency Workshop|
|RMC||Reverse Mortgage Counseling|
|RHC||Rental Housing Counseling|
|FBW||Financial, Budgeting and Credit Repair Workshops|
|DFC||Mortgage Delinquency and Default Resolution Counse|
|HMC||Services for Homeless Counseling|
callback parameter to the call. Works only when format is
- To run unit tests against a testing matrix of Python and Django versions, run:
You can also run a particular version, e.g.:
$ tox -e py27-dj18
INSTALLED_APPSin settings file.
manage.py syncdbto create three tables used by the module.
manage.py load_hud_datato load HUD data into local database.
load_hud_data management command
manage.py load_hud_data will load HUD data into local database. Error messages will be emailed to a list of emails