HUD Logo
USA%20Flag  

TLS 1.0 will be disabled on September 3rd, 2018. Please use TLS v1.2

Housing Counselor Web Service


Allows searching by name, city, state, and current location to find information regarding Housing Counseling Agencies.

Getting Started


All communication with the API is done through HTTP, and errors are communicated through HTTP response codes. The available response type is JSON







Response Codes


One of the following response codes will be returned with every request:

200 Successful request.
202 Request processing. You can retry your request, and when it's complete, you'll get a 200 instead.
400 Bad request.
401 Unauthorized. You're not authorized to access this resource.
404 Not found. The resource requested doesn't exist.
429 Too Many Requests. The client has made too many requests and is currently being rate limited.
500 Server errors.

Code Samples


function loadJson()
{
      $.getJSON(http://data.hud.gov/Housing_Counselor/search?AgencyName=&City=&State=,function(result){
            $.each(result, function(i, field){
                  //Access each field by using below code.
                  //this['agcid']
            });
      });
}

"Search" Web Service Fields


The following fields are available on the Housing Counselor web service.

AgencyName

City

State

Human Name: Agency Name

Human Name: City

Human Name: State

Type: Text

Type: Text

Type: Text

"Search By Location" Web Service Fields


The following fields are available on the Housing Counselor web service.

Lat

Long

Distance

Human Name: Latitude

Human Name: Longitude

Human Name: Distance (in miles)

Type: Text

Type: Text

Type: Text

Feedback and Questions


To give feedback or ask questions about this API, please contact HUD at Housing.counseling@hud.gov