# RentZoobi feed v1 field dictionary All field names are case-sensitive. Place these as flat children of `Listing action="upsert"`. No fields are allowed on a withdrawal. Use canonical taxonomy keys from `GET /api/v1/public/taxonomy`, not translated display labels. New listings require `property_key`, `space_type` and `title`. Fields marked **new property** are also required when this source has not created the property key before. Existing listing updates change only supplied listing fields; supplied inventory facts must match existing facts. Empty elements are not a clearing command. | Field | Group | Requirement / format | |---|---|---| | `property_key` | Identity | Required for a new listing. Stable source-scoped property ID, 1–120 ASCII characters, starting with a letter or digit and then letters/digits/`.`/`_`/`:`/`-`. | | `property_name` | Inventory | Optional name, at most 120 characters. | | `address_line1` | Inventory | **New property**. Street address, at most 200 characters. | | `address_line2` | Inventory | Optional second address line, at most 100 characters. Unit identity remains the listing's stable `external_id`. | | `city` | Inventory | **New property**. At most 100 characters. | | `region` | Inventory | **New property**. Uppercase U.S. state code or `DC`. All 50 states plus D.C. are accepted; territories are outside this version. | | `postal_code` | Inventory | **New property**. Five digits or ZIP+4 (`12345-6789`), retained as text. Format validity does not verify deliverability or a state/ZIP match. | | `property_type` | Inventory | **New property**. `single_family`, `townhouse`, `condo`, `multi_family`, `apartment` or `other`. | | `property_subtype` | Inventory | Used with `property_type=other`: `commercial`, `garage`, `manufactured`, `mixed_use`, `rv_park`, `office`, `parking`, `storage` or `specify`. Subject to inventory validation. | | `subtype_label` | Inventory | At most 60 characters; supply a descriptive label when the subtype is `specify`. | | `space_type` | Inventory | Required for a new listing. `unit`, `house`, `room`, `bed`, `lot`, `office`, `desk`, `storage`, `parking`, `garage` or `custom`. V1 cannot express parent-space relationships; not every type combination can create valid inventory without further setup. | | `space_label` | Inventory | Optional unit/space label, at most 60 characters. | | `title` | Listing | Required for a new listing; at most 120 characters. | | `description` | Listing | Plain text, at most 5000 characters. Supply accurate public property information, not private renter records. | | `market_keys` | Listing | Distinct canonical market keys separated by `\|`, such as `multifamily\|student-housing`. Do not add spaces around the separator. See list below and live taxonomy. | | `rent` | Listing | Nonnegative USD decimal amount, such as `1850.00`, with at most two decimal places. Currency symbols, grouping commas, ranges and negative values are rejected. | | `billing_period` | Listing | `month`, `week`, `day` or `hour`. Supply alongside rent so its period is explicit. | | `price_basis` | Listing | `whole_space` or `per_area` (per square foot). Supply alongside rent so its basis is explicit. | | `deposit` | Listing | Nonnegative USD decimal amount, such as `500.00`. Omission means unstated, not zero. | | `available_on` | Listing | Calendar date `YYYY-MM-DD`, such as `2026-12-01`; no timestamp or timezone suffix. | Market keys: `multifamily`, `single-family`, `mixed-portfolios`, `condo-hoa`, `manufactured-housing`, `student-housing`, `military-housing`, `affordable-housing`, `pha`, `social-housing`, `commercial`, `investment-management`, `self-storage`, `senior-living`, `coworking`, `occupier`. Some keys describe management segments rather than public rental categories. A key does not establish legal eligibility, publication approval or service availability for that market. ## Envelope attributes | Attribute | Rule | |---|---| | `RentZoobiFeed@version` | Required, exactly `1` | | `RentZoobiFeed@sequence` | Required integer 1–2147483647, increasing per ordinary source delivery | | `Listing@external_id` | Required immutable source-scoped space/listing ID, same lexical format as `property_key` | | `Listing@action` | Required `upsert` or `withdraw` | Do not send `space_key`, `parent_space_key`, `authority_basis`, photo URLs, contact records or unknown/custom elements. A partner cannot assert listing authority by writing an XML field. Normal owner authority and moderation checks apply. See the [integration guide](integration-guide.md), [synthetic sample](sample.xml) and [XSD](rentzoobi-feed-v1.xsd). The server applies contextual inventory and listing validation beyond the XSD. ## Listing facts These optional flat elements update listing facts. They do not change inventory, assert authority or create charges. Omitted facts remain unchanged; empty values are rejected. Use `true` or `false` for booleans, never `yes`, `no`, `1` or `0`. Multiple options use `|` without spaces or repeated keys. Integers allow a leading minus and 1–12 digits; numbers allow the same plus up to six decimal places, with no exponent. The per-field bounds below still apply. Money is USD with up to two decimal places and a maximum of 1000000000.00 dollars. A fact applies only when both its space-type restriction and market restriction match. `Any` means no restriction for that dimension. Nonapplicable facts are retained as inactive, so a later market change can restore them; they are not evidence of renter eligibility or public availability. Program facts describe the property and published rules, never private applicant characteristics. | Field | Type | Bounds or accepted values | Applies to spaces / markets | |---|---|---|---| | `bedrooms` | integer | 0 through 50 | `unit`, `house` / Any | | `bathrooms` | number | 0 through 50 | `unit`, `house` / Any | | `area_sqft` | number | 1 through 10000000 sqft | Any / Any | | `furnished` | boolean | `true` or `false` | `unit`, `house`, `room`, `bed`, `office`, `desk` / Any | | `floor` | integer | -5 through 200 | `unit`, `room`, `office`, `desk`, `storage` / Any | | `floor_plan` | text | 1–60 characters | `unit` / `multifamily` | | `private_bathroom` | boolean | `true` or `false` | `room`, `bed` / Any | | `household_size` | integer | 1 through 50 | `room`, `bed` / Any | | `detached` | boolean | `true` or `false` | `house` / `single-family` | | `yard` | boolean | `true` or `false` | `house`, `unit` / `single-family`, `condo-hoa` | | `elevator` | boolean | `true` or `false` | `unit`, `house`, `room`, `bed`, `office`, `desk`, `storage` / Any | | `step_free_entry` | boolean | `true` or `false` | Any / Any | | `air_conditioning` | boolean | `true` or `false` | `unit`, `house`, `room`, `bed`, `office`, `desk` / Any | | `laundry` | choice | `in_unit`, `in_building`, `none` | `unit`, `house`, `room`, `bed` / Any | | `parking_included` | boolean | `true` or `false` | `unit`, `house`, `room`, `bed`, `office`, `desk` / Any | | `community_amenities` | choices | `pool`, `fitness_room`, `clubhouse`, `playground`, `package_room`, `bike_storage`; multiple keys separated by `\|` | `unit`, `house`, `room`, `bed` / Any | | `access_hours` | choice | `always`, `business_hours`, `by_appointment` | `storage`, `desk`, `office`, `parking`, `garage` / Any | | `pets_allowed` | boolean | `true` or `false` | `unit`, `house`, `room`, `bed` / Any | | `minimum_term_months` | integer | 0 through 120 months | Any / Any | | `rental_approval_required` | boolean | `true` or `false` | Any / `condo-hoa` | | `guarantor_accepted` | boolean | `true` or `false` | `unit`, `house`, `room`, `bed` / `student-housing` | | `group_applications` | boolean | `true` or `false` | `unit`, `house`, `room`, `bed` / `student-housing` | | `academic_term` | choice | `academic_year`, `semester`, `summer`, `full_year` | `unit`, `house`, `room`, `bed` / `student-housing` | | `military_clause` | boolean | `true` or `false` | `unit`, `house`, `room`, `bed` / `military-housing` | | `utilities_included` | choices | `water`, `electricity`, `gas`, `heat`, `internet`, `trash`; multiple keys separated by `\|` | Any / Any | | `monthly_fees` | money | 0 through 1000000000.00 USD | Any / Any | | `association_move_in_fee` | money | 0 through 1000000000.00 USD | Any / `condo-hoa` | | `lot_rent` | money | 0 through 1000000000.00 USD | Any / `manufactured-housing` | | `common_area_charge` | money | 0 through 1000000000.00 USD | `office`, `desk`, `custom` / `commercial`, `occupier` | | `home_included` | boolean | `true` or `false` | `lot`, `house` / `manufactured-housing` | | `lot_length_ft` | number | 1 through 10000 ft | `lot` / Any | | `lot_width_ft` | number | 1 through 10000 ft | `lot` / Any | | `hookups` | choices | `water`, `sewer`, `electric_30a`, `electric_50a`, `gas`; multiple keys separated by `\|` | `lot` / Any | | `campus_name` | text | 1–120 characters | Any / `student-housing` | | `distance_to_campus_miles` | number | 0 through 500 miles | Any / `student-housing` | | `installation_name` | text | 1–120 characters | Any / `military-housing` | | `distance_to_installation_miles` | number | 0 through 500 miles | Any / `military-housing` | | `program_name` | text | 1–120 characters | Any / `affordable-housing`, `pha`, `social-housing`, `senior-living`, `military-housing` | | `provider_name` | text | 1–120 characters | Any / `affordable-housing`, `pha`, `social-housing` | | `accepts_vouchers` | boolean | `true` or `false` | `unit`, `house`, `room`, `bed` / Any | | `income_restricted` | boolean | `true` or `false` | Any / `affordable-housing`, `social-housing` | | `eligibility_effective_date` | date | Real date `YYYY-MM-DD` | Any / `affordable-housing`, `pha`, `social-housing` | | `waitlist_open` | boolean | `true` or `false` | Any / `affordable-housing`, `pha`, `social-housing`, `senior-living` | | `minimum_age` | integer | 50 through 80 | Any / `senior-living` | | `services_included` | choices | `meals`, `housekeeping`, `transport`, `activities`; multiple keys separated by `\|` | Any / `senior-living` | | `commercial_use` | choice | `office`, `retail`, `restaurant`, `industrial`, `flex` | `office`, `desk`, `custom`, `storage` / `commercial`, `occupier` | | `lease_type` | choice | `gross`, `modified_gross`, `triple_net` | Any / `commercial`, `occupier` | | `loading_access` | boolean | `true` or `false` | Any / `commercial`, `occupier` | | `workspace_kind` | choice | `hot_desk`, `dedicated_desk`, `private_office`, `meeting_room` | `office`, `desk` / `coworking` | | `capacity_people` | integer | 1 through 10000 | `office`, `desk` / Any | | `length_ft` | number | 1 through 1000 ft | `storage`, `parking`, `garage` / Any | | `width_ft` | number | 1 through 1000 ft | `storage`, `parking`, `garage` / Any | | `height_ft` | number | 1 through 200 ft | `storage`, `garage` / Any | | `climate_controlled` | boolean | `true` or `false` | `storage` / Any | | `drive_up` | boolean | `true` or `false` | `storage` / Any | | `cover` | choice | `enclosed`, `covered`, `open` | `parking`, `garage` / Any | | `ev_charging` | boolean | `true` or `false` | `parking`, `garage` / Any | | `security_features` | choices | `gated`, `cameras`, `on_site_staff`, `unit_alarm`; multiple keys separated by `\|` | `storage`, `parking`, `garage` / Any |