> ## Documentation Index
> Fetch the complete documentation index at: https://docs.canary.effectiveai.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Homeowners book schema

> Every table, key and core column of a homeowners book.

*Generated from the homeowners book schema. `ho.SCHEMA.to_pandas()` returns the core columns as a DataFrame.*

## `policies`

Key: `policy_id`. Optional table.

Each column is yours.

## `submissions`

Key: `submission_id`. Required table.

| Column | Type | Unit | Values | Required | Meaning |
| - | - | - | - | - | - |
| `policy_id` | id | | | Yes | The policy the submission prices. |
| `effective_date` | date | | | Yes | The date the rated term starts. |
| `term_months` | int | months | | | The length of the rated term. |
| `form` | enum | | `ho2`, `ho3`, `ho5`, `ho4`, `ho6`, `ho8`, `dp1`, `dp3` | | The policy form. |

## `insureds`

Key: `submission_id`, `insured_id`. Optional table.

| Column | Type | Unit | Values | Required | Meaning |
| - | - | - | - | - | - |
| `relationship` | enum | | `applicant`, `spouse`, `other` | | The insured's relationship to the applicant. |
| `birth_date` | date | | | | The insured's date of birth. |

## `dwellings`

Key: `submission_id`, `dwelling_id`. Required table.

| Column | Type | Unit | Values | Required | Meaning |
| - | - | - | - | - | - |
| `postal_code` | text | | | | The postal code of the premises. |
| `latitude` | number | degrees | | | The latitude of the premises. |
| `longitude` | number | degrees | | | The longitude of the premises. |
| `residence_type` | enum | | `single_family`, `townhouse`, `rowhouse`, `duplex`, `triplex`, `fourplex`, `condominium`, `cooperative`, `apartment`, `mobile_home` | | The kind of building the residence is in. |
| `occupant` | enum | | `owner`, `tenant`, `vacant` | | Who lives in the residence. |
| `residence_use` | enum | | `primary`, `secondary`, `seasonal` | | How often the occupant lives there. |
| `weeks_rented` | int | weeks | | | Weeks a year the residence is rented to others for short stays. |
| `months_unoccupied` | int | months | | | Months a year the residence stands unoccupied. |
| `units` | int | | | | The dwelling units in the building. |
| `residents` | int | | | | The people who live in the residence. |
| `construction` | enum | | `frame`, `masonry_veneer`, `masonry`, `fire_resistive`, `superior`, `mixed` | | The construction of the exterior walls. |
| `year_built` | int | | | | The year the building was built. |
| `living_area` | number | sq ft | | | The finished living area. |
| `stories` | int | | | | The stories above ground. |
| `bathrooms` | number | | | | The bathrooms, a half bath counting 0.5. |
| `foundation` | enum | | `basement`, `crawl_space`, `slab`, `pier`, `other` | | The building's foundation. |
| `roof_material` | enum | | `composition_shingle`, `wood_shingle`, `tile`, `slate`, `metal`, `flat_buildup`, `rubber_membrane`, `other` | | The roof's covering. |
| `roof_shape` | enum | | `gable`, `hip`, `flat`, `mansard`, `gambrel`, `shed`, `other` | | The roof's shape. |
| `roof_year` | int | | | | The year the roof covering was installed. |
| `protection_class` | text | | | | The ISO public protection class of the premises, such as 3 or 8B. |
| `fire_station_distance` | number | miles | | | Road distance to the responding fire station. |
| `hydrant_distance` | number | feet | | | Distance to the nearest fire hydrant. |
| `replacement_cost` | number | USD | | | The estimated cost to rebuild the dwelling. |
| `purchase_date` | date | | | | The date the insured bought the residence. |
| `mortgages` | int | | | | The mortgages on the residence. |

## `features`

Key: `submission_id`, `dwelling_id`, `feature_id`. Optional table.

`feature_id` is one of these values:

* `smoke_detector`
* `fire_alarm_local`
* `fire_alarm_central`
* `burglar_alarm_local`
* `burglar_alarm_central`
* `sprinkler_full`
* `sprinkler_partial`
* `water_leak_detector`
* `water_shutoff`
* `deadbolt`
* `fire_extinguisher`
* `gated_community`
* `class_a_roof`
* `enclosed_eaves`
* `ember_resistant_vents`
* `noncombustible_base`
* `ember_resistant_zone`
* `defensible_space`
* `multipane_windows`
* `firewise_community`
* `fire_risk_reduction_community`
* `ibhs_wildfire_prepared`
* `opening_protection`
* `impact_resistant_roof`
* `fortified_roof`
* `fortified_home`
* `swimming_pool`
* `trampoline`
* `dog`
* `livestock`
* `solid_fuel_heater`

Each column is yours.

## `coverages`

Key: `submission_id`, `dwelling_id`, `coverage_id`. Optional table.

`coverage_id` is one of these values:

* `dwelling`
* `other_structures`
* `personal_property`
* `loss_of_use`
* `personal_liability`
* `medical_payments`
* `extended_replacement_cost`
* `personal_property_replacement_cost`
* `ordinance_or_law`
* `water_backup`
* `service_line`
* `equipment_breakdown`
* `loss_assessment`
* `building_additions_alterations`
* `trees_shrubs`
* `matching`
* `fungi`
* `earthquake`
* `credit_card_forgery`
* `identity_fraud`
* `home_cyber`
* `green_home`
* `personal_injury`
* `animal_liability`
* `home_business`
* `home_day_care`
* `home_sharing`
* `residence_employees`
* `additional_residence`
* `watercraft`
* `golf_cart`
* `incidental_farming`

| Column | Type | Unit | Values | Required | Meaning |
| - | - | - | - | - | - |
| `limit` | number | USD | | | The limit. |
| `limit_percent` | number | % | | | A limit filed as a percent of the dwelling limit, such as 25 for extended replacement cost of 125%. |
| `deductible` | number | USD | | | The coverage's own deductible. |

## `deductibles`

Key: `submission_id`, `dwelling_id`, `peril`. Optional table.

`peril` is one of `all_other_perils`, `wind_hail`, `hurricane`, `named_storm`, `earthquake`, `water`, `theft`.

| Column | Type | Unit | Values | Required | Meaning |
| - | - | - | - | - | - |
| `amount` | number | USD | | | A deductible stated as an amount. |
| `percent` | number | % | | | A deductible stated as a percent of the dwelling limit. |

## `special_limits`

Key: `submission_id`, `property_class`. Optional table.

`property_class` is one of `jewelry`, `watches`, `furs`, `fine_arts`, `silverware`, `cameras`, `musical_instruments`, `stamps`, `coins`, `firearms`, `golf_equipment`, `sports_equipment`, `computers`, `collectibles`, `money`, `securities`, `other`.

| Column | Type | Unit | Values | Required | Meaning |
| - | - | - | - | - | - |
| `limit` | number | USD | | | The limit for the class. |

## `scheduled_items`

Key: `submission_id`, `item_id`. Optional table.

| Column | Type | Unit | Values | Required | Meaning |
| - | - | - | - | - | - |
| `property_class` | enum | | `jewelry`, `watches`, `furs`, `fine_arts`, `silverware`, `cameras`, `musical_instruments`, `stamps`, `coins`, `firearms`, `golf_equipment`, `sports_equipment`, `computers`, `collectibles`, `money`, `securities`, `other` | | The class of the scheduled item. |
| `value` | number | USD | | | The item's scheduled value. |
| `appraisal_date` | date | | | | The date the item was last appraised. |
| `vaulted` | bool | | | | Whether the item is kept in a bank vault. |

## `losses`

Key: `submission_id`, `loss_id`. Optional table.

| Column | Type | Unit | Values | Required | Meaning |
| - | - | - | - | - | - |
| `insured_id` | id | | | | The insured the loss is charged to, if any. |
| `dwelling_id` | id | | | | The dwelling the loss occurred at, if it is this one. |
| `loss_date` | date | | | | The date the loss occurred. |
| `peril` | enum | | `fire`, `lightning`, `wind`, `hail`, `water_weather`, `water_non_weather`, `theft`, `vandalism`, `liability`, `mold`, `earthquake`, `other` | | The cause of the loss. |
| `amount_paid` | number | USD | | | The amount paid on the claim. |
| `catastrophe` | bool | | | | Whether the loss is part of a declared catastrophe. |

## `other_policies`

Key: `submission_id`, `other_policy_id`. Optional table.

| Column | Type | Unit | Values | Required | Meaning |
| - | - | - | - | - | - |
| `line` | enum | | `auto`, `home`, `condo`, `renters`, `dwelling`, `umbrella`, `life`, `motorcycle`, `watercraft`, `other` | | The policy's line of business. |
| `carrier` | text | | | | The insurer that writes the policy. |
| `start_date` | date | | | | The date the policy first took effect. |
| `end_date` | date | | | | The date the policy ended, if it has. |
| `vehicle_count` | int | | | | The vehicles the policy insures. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.