Homes
Homes represent the physical structures that are being insured in a personal risk profile. On this page, we'll dive into the different home endpoints you can use to manage them programmatically.
The Home object
Home objects represent a single home in a personal risk profile. They contain the following properties and relationships:
Personal-only Properties
These properties are available only for personal risk profiles.- Name
description- Type
- string
- Filterable
- Sortable
- Description
A text description of the home
- Name
year_built- Type
- nullable string
- Filterable
- Sortable
- Description
The year the home was built
- Name
number_stories- Type
- nullable int
- Filterable
- Sortable
- Description
The home's total number of floors or levels
- Name
floor_area- Type
- nullable int
- Filterable
- Sortable
- Description
The home's total square footage
- Name
construction- Type
- nullable enum
- Filterable
- Sortable
- Description
The home's construction type
- Name
Frame- Description
- Frame
- Name
Joisted Masonry- Description
- Joisted Masonry
- Name
Noncombustible- Description
- Noncombustible
- Name
Masonry Noncombustible- Description
- Masonry Noncombustible
- Name
Modified Fire Resistive- Description
- Modified Fire Resistive
- Name
Fire Resistive- Description
- Fire Resistive
- Name
occupancy- Type
- nullable string
- Sortable
- Description
How the home is being used, whether it is owner-occupant or renter-occupied for homeowners and the number of families for which the home is designed
- Name
protection_class- Type
- nullable string
- Sortable
- Description
A rating from 1-10 indicating how well the home is protected from fire. A class of 1 indicates the best protection, while a class of 10 indicates the worst protection
- Name
sprinkler- Type
- nullable string
- Filterable
- Sortable
- Description
Does the home have a fire suppression sprinkler system? Possible values include: Yes, No, Partial
- Name
itv- Type
- nullable float
- Filterable
- Sortable
- Description
Insurance-to-value, the estimated full dollar cost to replace or restore the home
- Name
assessor- Type
- nullable float
- Filterable
- Sortable
- Description
The assessed dollar value of the home for tax purposes
- Name
appraisal- Type
- nullable float
- Filterable
- Sortable
- Description
The appraised dollar market value of the home
- Name
notes- Type
- nullable string
- Description
Any additional notes or comments about the home
Meta
- Name
created- Type
- timestamp
- Filterable
- Sortable
- Description
An ISO-8601 timestamp (UTC) indicating when the home was created
- Name
updated- Type
- timestamp
- Filterable
- Sortable
- Description
An ISO-8601 timestamp (UTC) indicating when the home was last updated
- Name
has_property_data- Type
- bool
- Filterable
- Description
When
true, indicates the home has 3rd-party property data available
Personal-only Relations
Learn more about including relations.- Name
address- Type
- Address
- Filterable
- Sortable
- Name
attachments- Type
- Attachment[]
- Name
attachments.uploader- Type
- User
- Description
The user who uploaded the attachment
List all homes
This endpoint allows you to retrieve a paginated list of all homes in the corresponding personal risk profile.
Parameters
See the home object for a list of all available filters and sorts.
Searchable
You can search for homes by providing a search query in the filter[search] parameter.
The search query will be matched against a home's name or address.
Request
curl -G https://app.wunderite.com/api/v1/risks/{risk}/data/homes \
-H "Authorization: Bearer {token}" \
-d filter[search]=Location \
-d per_page=50
Response
{ "data": [ { "object": "home", "uuid": "ea0d1c6b-ad78-45c2-86fa-914193bff3ed", "data": { "description": "Lasso Primary Home", "year_built": "2005", "number_stories": 1, "floor_area": 6960,
Create homes
This endpoint allows you to create new homes in the corresponding personal risk profile.
At least one home object must be provided in the request body.
Required properties
- Name
description- Type
- string
- Description
The value that will be used to describe the home
- Name
address- Type
- Address
- Description
An address object that should be created with the home
Optional properties
See all available properties in the home properties section.
Request with sub resources
curl -X POST https://app.wunderite.com/api/v1/risks/{risk}/data/homes?include=address \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-d '{
"data": [
{
"object": "home",
"data": {
"description": "Home",
"year_built": "2000",
"number_stories": 2,
"floor_area": 10000,
"construction": "Frame",
"notes": "This is the main residence.",
"address": {
"object": "address",
"data": {
"street_number": "123",
"address1": "Main St",
"city": "Boston",
"state": "MA",
"zip": "02108"
}
}
}
}
]
}'
Response
{ "data": [ { "object": "home", "uuid": "bbd21479-c535-44ce-b526-1480f2dbd893", "data": { "description": "Home", "year_built": "2000", "number_stories": 2, "floor_area": 10000,
Update homes
This endpoint allows you to perform bulk updates on homes.
At least one home object must be provided in the request body. Each object must contain at least one property from the home properties section.
You can also update an address in the same request if you provide the address property with an Address object.
Properties that are not provided will not be updated.
To clear a property, provide a null value.
Request
curl -X PATCH https://app.wunderite.com/api/v1/risks/{risk}/data \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-d '{
"data": [
{
"object": "home",
"uuid": "ea0d1c6b-ad78-45c2-86fa-914193bff3ed",
"data": {
"description": "Lasso Primary Home",
"year_built": "2005",
"number_stories": 1,
"floor_area": 6960,
"construction": "Fire Resistive",
"occupancy": "Owner Occupied",
"protection_class": "P3, Protected 3",
"sprinkler": null,
"flood_zone": "X",
"itv": null,
"assessor": 134527,
"appraisal": 1000000,
"notes": null
}
}
]
}'
Response
{ "data": [ { "object": "home", "uuid": "ea0d1c6b-ad78-45c2-86fa-914193bff3ed", "data": { "description": "Lasso Primary Home", "year_built": "2005", "number_stories": 1, "floor_area": 6960,
Request with sub resources
curl -X PATCH https://app.wunderite.com/api/v1/risks/{risk}/data \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-d '{
"data": [
{
"object": "home",
"uuid": "ea0d1c6b-ad78-45c2-86fa-914193bff3ed",
"data": {
"description": "Lasso Primary Home",
"year_built": "2005",
"number_stories": 1,
"floor_area": 6960,
"construction": "Fire Resistive",
"occupancy": "Owner Occupied",
"protection_class": "P3, Protected 3",
"sprinkler": null,
"flood_zone": "X",
"itv": null,
"assessor": 134527,
"appraisal": 1000000,
"notes": null,
"address": {
"object": "address",
"data": {
"street_number": 123,
"address1": "Test Street",
"address2": null,
"city": "Boston",
"state": "MA",
"zip": "08077",
"county": "Suffolk",
"lat": 0,
"lng": 0
}
}
}
}
]
}'
Response
{ "data": [ { "object": "home", "uuid": "ea0d1c6b-ad78-45c2-86fa-914193bff3ed", "data": { "description": "Lasso Primary Home", "year_built": "2005", "number_stories": 1, "floor_area": 6960,
Delete homes
This endpoint allows you to bulk delete risk data, including homes.
At least one home object must be provided in the request body to delete the corresponding home.
Required properties
- Name
object- Type
- string
- Description
The object type of the data to delete. Must be
homein this case.
- Name
uuid- Type
- string
- Description
The UUID of the home to delete.
Request
curl -X DELETE https://app.wunderite.com/api/v1/risks/{risk}/data \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-d '{
"data": [
{
"object": "home",
"uuid": "ea0d1c6b-ad78-45c2-86fa-914193bff3ed"
}
]
}'
Response
{
"data": [
{
"object": "home",
"uuid": "ea0d1c6b-ad78-45c2-86fa-914193bff3ed",
"profile_type": "personal"
}
]
}