Documentation

Real Estate Functions

Generate property and real estate data

Real Estate Functions

Generate realistic real estate and property data for testing property management applications.


Property Identification

generate_mls_number

Generate Multiple Listing Service (MLS) numbers.

Category: Property Type: Generator Data Types: string

ParameterTypeDefaultDescription
regionstringUSUS, CA (Canada)
columns:
  - name: mls_number
    function: generate_mls_number

Output: MLS-12345678


generate_property_id

Generate unique property identifiers.

Category: Property Type: Generator Data Types: string

columns:
  - name: property_id
    function: generate_property_id

Output: PROP-2024-ABC12345


generate_parcel_number

Generate assessor parcel numbers (APN).

Category: Property Type: Generator Data Types: string

columns:
  - name: apn
    function: generate_parcel_number

Output: 123-456-789


generate_deed_number

Generate property deed reference numbers.

Category: Property Type: Generator Data Types: string

columns:
  - name: deed_number
    function: generate_deed_number

Output: DEED-20240315-ABC123


generate_mortgage_number

Generate mortgage loan numbers.

Category: Property Type: Generator Data Types: string

columns:
  - name: mortgage_number
    function: generate_mortgage_number

Output: MORT-123456789012


generate_escrow_number

Generate escrow account numbers.

Category: Property Type: Generator Data Types: string

columns:
  - name: escrow_number
    function: generate_escrow_number

Output: ESC-123456789012


Property Details

generate_property_type

Generate property types.

Category: Property Type: Generator Data Types: string

ParameterTypeDefaultDescription
categorystringallresidential, commercial, land, all
columns:
  - name: property_type
    function: generate_property_type
    parameters:
      category: residential

Output by category:

  • residential: Single Family Home, Condominium, Townhouse
  • commercial: Office Building, Retail Space, Warehouse
  • land: Vacant Land, Agricultural, Development Land

generate_square_footage

Generate realistic square footage.

Category: Property Type: Generator Data Types: integer

ParameterTypeDefaultDescription
property_typestringresidentialresidential, commercial, industrial, retail
columns:
  - name: sqft
    function: generate_square_footage
    parameters:
      property_type: residential

Output ranges:

  • residential: 500-5,000
  • commercial: 1,000-50,000
  • industrial: 5,000-200,000
  • retail: 500-25,000

generate_lot_size

Generate property lot sizes.

Category: Property Type: Generator Data Types: string

ParameterTypeDefaultDescription
unitstringsqftsqft, acres, hectares
columns:
  - name: lot_size
    function: generate_lot_size
    parameters:
      unit: acres

Output: 0.25 acres, 10,000 sq ft


generate_year_built

Generate realistic construction years.

Category: Property Type: Generator Data Types: integer

Weighted toward more recent construction.

columns:
  - name: year_built
    function: generate_year_built

Output: 1985, 2015, 1962


Valuations

generate_property_value

Generate assessed property values.

Category: Property Type: Generator Data Types: string

ParameterTypeDefaultDescription
property_typestringresidentialresidential, commercial, industrial, land
regionstringaveragehigh_cost, average, low_cost
columns:
  - name: assessed_value
    function: generate_property_value
    parameters:
      property_type: residential
      region: high_cost

Output: $1,250,000


generate_rental_price

Generate monthly rental prices.

Category: Property Type: Generator Data Types: string

ParameterTypeDefaultDescription
property_typestringapartmentapartment, house, condo, townhouse, studio
bedroomsinteger2Number of bedrooms
columns:
  - name: monthly_rent
    function: generate_rental_price
    parameters:
      property_type: apartment
      bedrooms: 2

Output: $1,850/month


generate_hoa_fee

Generate HOA monthly fees.

Category: Property Type: Generator Data Types: string

ParameterTypeDefaultDescription
property_typestringcondocondo, townhouse, single_family, luxury
columns:
  - name: hoa_fee
    function: generate_hoa_fee
    parameters:
      property_type: condo

Output: $450/month


generate_property_tax

Generate annual property tax amounts.

Category: Property Type: Generator Data Types: string

ParameterTypeDefaultDescription
property_valueinteger500000Property value
tax_ratefloatrandomTax rate as percentage
columns:
  - name: annual_tax
    function: generate_property_tax
    parameters:
      property_value: 750000

Output: $9,375/year


Zoning & Permits

generate_zoning_code

Generate zoning classification codes.

Category: Property Type: Generator Data Types: string

columns:
  - name: zoning
    function: generate_zoning_code

Output: R1, C2, I1, MU


generate_building_permit

Generate building permit numbers.

Category: Property Type: Generator Data Types: string

columns:
  - name: permit_number
    function: generate_building_permit

Output: BP-2024-1234567


generate_inspection_id

Generate property inspection IDs.

Category: Property Type: Generator Data Types: string

ParameterTypeDefaultDescription
inspection_typestringgeneralgeneral, electrical, plumbing, hvac, structural, fire, final
columns:
  - name: inspection_id
    function: generate_inspection_id
    parameters:
      inspection_type: electrical

Output: ELE-20240315-1234


generate_appraisal_number

Generate property appraisal numbers.

Category: Property Type: Generator Data Types: string

columns:
  - name: appraisal_number
    function: generate_appraisal_number

Output: APP-20240315-ABC12345


Complete Listing Example

tables:
  - name: listings
    columns:
      - name: mls_number
        function: generate_mls_number
      - name: property_type
        function: generate_property_type
        parameters:
          category: residential
      - name: address
        function: generate_address
      - name: city
        function: generate_city
      - name: sqft
        function: generate_square_footage
      - name: lot_size
        function: generate_lot_size
      - name: year_built
        function: generate_year_built
      - name: list_price
        function: generate_property_value
      - name: zoning
        function: generate_zoning_code