htag-sdk 1.9.2__tar.gz → 1.9.3__tar.gz

{htag_sdk-1.9.2 → htag_sdk-1.9.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: htag-sdk
-Version: 1.9.2
+Version: 1.9.3
 Summary: Official Python SDK for the HtAG Location Intelligence API — address search, property data, and market analytics for Australia
 Project-URL: Homepage, https://developer.htagai.com
 Project-URL: Documentation, https://developer.htagai.com

{htag_sdk-1.9.2 → htag_sdk-1.9.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "htag-sdk"
-version = "1.9.2"
+version = "1.9.3"
 description = "Official Python SDK for the HtAG Location Intelligence API — address search, property data, and market analytics for Australia"
 readme = "README.md"
 license = "MIT"

{htag_sdk-1.9.2 → htag_sdk-1.9.3}/src/htag_sdk/__init__.py

@@ -62,8 +62,11 @@ from htag_sdk.property.models import (
     PropertyAvmResponse,
     PropertyEstimatesRecord,
     PropertyEstimatesResponse,
+    PropertyHistoryResponse,
     PropertyMarketRecord,
     PropertyMarketResponse,
+    PropertyRentedHistoryRecord,
+    PropertySoldHistoryRecord,
     PropertySummaryRecord,
     PropertySummaryResponse,
     RentedPropertiesResponse,
@@ -233,8 +236,11 @@ __all__ = [
     "PropertyAvmResponse",
     "PropertyEstimatesRecord",
     "PropertyEstimatesResponse",
+    "PropertyHistoryResponse",
     "PropertyMarketRecord",
     "PropertyMarketResponse",
+    "PropertyRentedHistoryRecord",
+    "PropertySoldHistoryRecord",
     "PropertySummaryRecord",
     "PropertySummaryResponse",
     "RentedPropertiesResponse",

{htag_sdk-1.9.2 → htag_sdk-1.9.3}/src/htag_sdk/markets/models.py

@@ -722,6 +722,7 @@ class MarketFundamentalsRecord(BaseModel):
     uh_ratio: Optional[float] = None
     uhv_ratio: Optional[float] = None
     years_to_own: Optional[float] = None
+    non_res_ba_per_capita_value: Optional[float] = None
 
 
 class MarketCycleRecord(BaseModel):

{htag_sdk-1.9.2 → htag_sdk-1.9.3}/src/htag_sdk/property/__init__.py

@@ -7,8 +7,11 @@ from htag_sdk.property.models import (
     PropertyAvmResponse,
     PropertyEstimatesRecord,
     PropertyEstimatesResponse,
+    PropertyHistoryResponse,
     PropertyMarketRecord,
     PropertyMarketResponse,
+    PropertyRentedHistoryRecord,
+    PropertySoldHistoryRecord,
     PropertySummaryRecord,
     PropertySummaryResponse,
     SoldPropertiesResponse,
@@ -22,8 +25,11 @@ __all__ = [
     "PropertyAvmResponse",
     "PropertyEstimatesRecord",
     "PropertyEstimatesResponse",
+    "PropertyHistoryResponse",
     "PropertyMarketRecord",
     "PropertyMarketResponse",
+    "PropertyRentedHistoryRecord",
+    "PropertySoldHistoryRecord",
     "PropertySummaryRecord",
     "PropertySummaryResponse",
     "SoldPropertiesResponse",

{htag_sdk-1.9.2 → htag_sdk-1.9.3}/src/htag_sdk/property/async_client.py

@@ -6,6 +6,7 @@ from typing import TYPE_CHECKING, List, Optional, Union
 
 from htag_sdk.property.models import (
     PropertyEstimatesResponse,
+    PropertyHistoryResponse,
     PropertyMarketResponse,
     PropertySummaryResponse,
     RentedPropertiesResponse,
@@ -230,6 +231,26 @@ class AsyncPropertyClient:
         data = await self._client._request("GET", "/property/market", params=params)
         return PropertyMarketResponse.model_validate(data)
 
+    async def history(
+        self,
+        *,
+        address_key: str,
+        sold: bool = True,
+        rented: bool = True,
+    ) -> PropertyHistoryResponse:
+        """Async: retrieve the full sale and/or rental history for an address.
+
+        See :meth:`htag_sdk.property.client.PropertyClient.history` for full
+        documentation.
+        """
+        params = {
+            "address_key": address_key,
+            "sold": sold,
+            "rented": rented,
+        }
+        data = await self._client._request("GET", "/property/history", params=params)
+        return PropertyHistoryResponse.model_validate(data)
+
     async def structural_adjustment(
         self,
         *,

{htag_sdk-1.9.2 → htag_sdk-1.9.3}/src/htag_sdk/property/client.py

@@ -6,6 +6,7 @@ from typing import TYPE_CHECKING, List, Optional, Union
 
 from htag_sdk.property.models import (
     PropertyEstimatesResponse,
+    PropertyHistoryResponse,
     PropertyMarketResponse,
     PropertySummaryResponse,
     RentedPropertiesResponse,
@@ -257,6 +258,34 @@ class PropertyClient:
         data = self._client._request("GET", "/property/market", params=params)
         return PropertyMarketResponse.model_validate(data)
 
+    def history(
+        self,
+        *,
+        address_key: str,
+        sold: bool = True,
+        rented: bool = True,
+    ) -> PropertyHistoryResponse:
+        """Retrieve the full sale and/or rental history for an address.
+
+        Args:
+            address_key: Canonical HTAG address key.
+            sold: Include sale history (default ``True``).
+            rented: Include rental history (default ``True``). At least one of
+                ``sold`` or ``rented`` must be ``True``.
+
+        Returns:
+            A :class:`PropertyHistoryResponse` with sale and rental timelines,
+            the canonical top-level ``property_type``, and a billable ``total``
+            row count.
+        """
+        params = {
+            "address_key": address_key,
+            "sold": sold,
+            "rented": rented,
+        }
+        data = self._client._request("GET", "/property/history", params=params)
+        return PropertyHistoryResponse.model_validate(data)
+
     def structural_adjustment(
         self,
         *,

{htag_sdk-1.9.2 → htag_sdk-1.9.3}/src/htag_sdk/property/models.py

@@ -137,6 +137,46 @@ class PropertyMarketResponse(BaseModel):
     total: int
 
 
+class PropertySoldHistoryRecord(BaseModel):
+    """A single sale entry in the property history timeline."""
+
+    model_config = ConfigDict(populate_by_name=True)
+
+    sale_date: Optional[str] = None
+    sale_price: Optional[int] = None
+    bedrooms: Optional[int] = None
+    bathrooms: Optional[int] = None
+    car_spaces: Optional[int] = None
+    land_area: Optional[float] = None
+    floor_area: Optional[float] = None
+
+
+class PropertyRentedHistoryRecord(BaseModel):
+    """A single rental entry in the property history timeline."""
+
+    model_config = ConfigDict(populate_by_name=True)
+
+    list_date: Optional[str] = None
+    rent: Optional[float] = None
+    bedrooms: Optional[int] = None
+    bathrooms: Optional[int] = None
+    car_spaces: Optional[int] = None
+    land_area: Optional[float] = None
+    floor_area: Optional[float] = None
+
+
+class PropertyHistoryResponse(BaseModel):
+    """Response from the property history endpoint."""
+
+    model_config = ConfigDict(populate_by_name=True)
+
+    address_key: str
+    property_type: Optional[str] = None
+    total: int = 0
+    sales: Optional[List[PropertySoldHistoryRecord]] = None
+    rentals: Optional[List[PropertyRentedHistoryRecord]] = None
+
+
 class PropertyAvmRecord(BaseModel):
     """A single AVM valuation result."""
 

{htag_sdk-1.9.2 → htag_sdk-1.9.3}/src/htag_sdk/reference/models.py

@@ -193,6 +193,7 @@ class AddressKeyRecord(BaseModel):
     parking: Optional[int] = None
     lot_size: Optional[float] = None
     property_group: Optional[str] = None
+    own_status: str = 'owner occupied'
 
 
 class AddressKeyEnumerationResponse(BaseModel):

{htag_sdk-1.9.2 → htag_sdk-1.9.3}/tests/test_domains.py

@@ -215,6 +215,40 @@ class TestPropertyClient:
         assert result.results[0].address_key == "100102HICKOXSTREETTRARALGONVIC3844"
         client.close()
 
+    def test_property_history_sends_correct_params(self):
+        client = HtAgApi(api_key="sk-test", environment="prod")
+        mock_resp = _mock_response(
+            200,
+            {
+                "address_key": "AK_HIST_1",
+                "property_type": "unit",
+                "total": 2,
+                "sales": [{"sale_date": "2025-10-13", "sale_price": 750000}],
+                "rentals": [{"list_date": "2024-05-04", "rent": 550.0}],
+            },
+        )
+
+        with patch.object(client._http, "request", return_value=mock_resp) as mock_req:
+            result = client.property.history(
+                address_key="AK_HIST_1",
+                sold=True,
+                rented=False,
+            )
+
+        call_kwargs = mock_req.call_args
+        assert call_kwargs[0][0] == "GET"
+        assert "/property/history" in call_kwargs[0][1]
+        params = call_kwargs[1]["params"]
+        assert params["address_key"] == "AK_HIST_1"
+        assert params["sold"] == "true"
+        assert params["rented"] == "false"
+        assert result.address_key == "AK_HIST_1"
+        assert result.property_type == "unit"
+        assert result.total == 2
+        assert result.sales[0].sale_price == 750000
+        assert result.rentals[0].rent == 550.0
+        client.close()
+
     def test_rented_search_property_type_list_param(self):
         client = HtAgApi(api_key="sk-test", environment="prod")
         mock_resp = _mock_response(200, {"results": [], "total": 0})