Api root https://api.neightbourhoodcolab.com

GET /houses

Returns all houses and their owners

Example endpoint: GET https://api.neightbourhoodcolab.com/houses?api_key=my_key

Query options:

Response

{
	"houses": [
		{
			"owner": {
        "id": number unique id,
        "name": string,
        "age": number,
        "number_of_occupants": number,
      }
			"house": {
        "id": number unique id,
        "house_number": number,
        "house_name": string,
        "address_line_1":  string,
        "address_line_2":  string or null,
        "address_line_3":  string or null,
        "county": string,
        "postcode": string,
      }
		},
    // ...
	]
}

GET /houses/search

Returns and array of houses based on search query parametres.

By default returns all houses and owners.

Example endpoint: GET https://api.neightbourhoodcolab.com/houses/search?api_key=my_key&postcode=np255py

Query options:

our data is stored in a relational database and the structure is outlined below.