Housing Market API Reference

This section documents the Housing Market module, which manages property transactions, rental markets, and housing market clearing.

macromodel.markets.housing_market.housing_market.HousingMarket

Housing market model implementing property transactions and rental agreements.

This class implements a comprehensive housing market model that handles both property sales and rental agreements. It manages property valuations, market clearing mechanisms, and tracks various market metrics over time.

Key Features: 1. Property Management: - Track property ownership and occupancy - Update property valuations - Monitor rental status - Handle property transactions

1. Market Clearing:
2. Match buyers with sellers
3. Match tenants with landlords
4. Process transactions

5. Update ownership records

6. Market Analysis:

7. Track price-to-value ratios
8. Monitor rent-to-value ratios
9. Calculate market statistics

10. Generate market reports

11. Time Series Tracking:

12. Property values over time
13. Transaction volumes
14. Price and rent distributions
15. Market efficiency metrics

The model supports: - Owner-occupied and rental properties - Multiple property ownership - Vacant properties - Price discovery mechanisms - Market clearing algorithms

Clearing Mechanisms (Abstract)

macromodel.markets.housing_market.func.clearing.HousingMarketClearer

Abstract base class for housing market clearing algorithms.

This class defines the interface for market clearing mechanisms that match properties with potential buyers or renters. It supports both sales and rental markets with configurable matching behavior.