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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: htag-sdk
-Version: 1.9.2
+Version: 1.9.4
 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.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "htag-sdk"
-version = "1.9.2"
+version = "1.9.4"
 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.4}/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.4/src/htag_sdk/address/__init__.py

@@ -0,0 +1,91 @@
+"""Address API domain — search, insights, standardisation, geocode, environment, demographics, schools, features."""
+
+from htag_sdk.address.async_client import AsyncAddressClient
+from htag_sdk.address.client import AddressClient
+from htag_sdk.address.models import (
+    AddressAmenitiesRecord,
+    AddressAmenitiesResponse,
+    AddressAviationRecord,
+    AddressAviationResponse,
+    AddressCbdProximityRecord,
+    AddressCbdProximityResponse,
+    AddressCoastalRecord,
+    AddressCoastalResponse,
+    AddressEssentialsRecord,
+    AddressEssentialsResponse,
+    AddressFeatureBaseRecord,
+    AddressGreenSpaceRecord,
+    AddressGreenSpaceResponse,
+    AddressHazardsRecord,
+    AddressHazardsResponse,
+    AddressInsightsResponse,
+    AddressNuisanceRecord,
+    AddressNuisanceResponse,
+    AddressRecord,
+    AddressRoadInfrastructureRecord,
+    AddressRoadInfrastructureResponse,
+    AddressSafetyRecord,
+    AddressSafetyResponse,
+    AddressSearchResponse,
+    AddressSearchResult,
+    AddressTransportRecord,
+    AddressTransportResponse,
+    AddressWalkabilityRecord,
+    AddressWalkabilityResponse,
+    AustralianAddressComponents,
+    BatchStandardiseResponse,
+    DemographicsRecord,
+    DemographicsResponse,
+    EnvironmentRecord,
+    EnvironmentResponse,
+    GeocodeRecord,
+    GeocodeResponse,
+    SchoolRecord,
+    SchoolsResponse,
+    StandardiseResult,
+)
+
+__all__ = [
+    "AddressClient",
+    "AsyncAddressClient",
+    "AddressAmenitiesRecord",
+    "AddressAmenitiesResponse",
+    "AddressAviationRecord",
+    "AddressAviationResponse",
+    "AddressCbdProximityRecord",
+    "AddressCbdProximityResponse",
+    "AddressCoastalRecord",
+    "AddressCoastalResponse",
+    "AddressEssentialsRecord",
+    "AddressEssentialsResponse",
+    "AddressFeatureBaseRecord",
+    "AddressGreenSpaceRecord",
+    "AddressGreenSpaceResponse",
+    "AddressHazardsRecord",
+    "AddressHazardsResponse",
+    "AddressInsightsResponse",
+    "AddressNuisanceRecord",
+    "AddressNuisanceResponse",
+    "AddressRecord",
+    "AddressRoadInfrastructureRecord",
+    "AddressRoadInfrastructureResponse",
+    "AddressSafetyRecord",
+    "AddressSafetyResponse",
+    "AddressSearchResponse",
+    "AddressSearchResult",
+    "AddressTransportRecord",
+    "AddressTransportResponse",
+    "AddressWalkabilityRecord",
+    "AddressWalkabilityResponse",
+    "AustralianAddressComponents",
+    "BatchStandardiseResponse",
+    "DemographicsRecord",
+    "DemographicsResponse",
+    "EnvironmentRecord",
+    "EnvironmentResponse",
+    "GeocodeRecord",
+    "GeocodeResponse",
+    "SchoolRecord",
+    "SchoolsResponse",
+    "StandardiseResult",
+]

htag_sdk-1.9.4/src/htag_sdk/address/async_client.py

@@ -0,0 +1,368 @@
+"""Asynchronous client for the Address API domain."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, List, Optional
+
+from htag_sdk.address.models import (
+    AddressAmenitiesResponse,
+    AddressAviationResponse,
+    AddressCbdProximityResponse,
+    AddressCoastalResponse,
+    AddressEssentialsResponse,
+    AddressGreenSpaceResponse,
+    AddressHazardsResponse,
+    AddressNuisanceResponse,
+    AddressRoadInfrastructureResponse,
+    AddressSafetyResponse,
+    AddressTransportResponse,
+    AddressWalkabilityResponse,
+    BatchStandardiseResponse,
+    DemographicsResponse,
+    EnvironmentResponse,
+    GeocodeResponse,
+    SchoolsResponse,
+)
+
+if TYPE_CHECKING:
+    from htag_sdk._base import AsyncRequestMixin
+
+
+class AsyncAddressClient:
+    """Asynchronous client for address search, insights, and standardisation.
+
+    This class is not instantiated directly. Access it via ``client.address``.
+    """
+
+    _client: "AsyncRequestMixin"
+
+    def __init__(self, client: "AsyncRequestMixin") -> None:
+        self._client = client
+
+    async def standardise(
+        self,
+        addresses: List[str],
+    ) -> BatchStandardiseResponse:
+        """Standardise a batch of free-text Australian addresses.
+
+        Args:
+            addresses: List of address strings to standardise (max 50).
+
+        Returns:
+            A :class:`BatchStandardiseResponse` with standardised components
+            for each input address.
+        """
+        data = await self._client._request(
+            "POST",
+            "/address/standardise",
+            json={"addresses": addresses},
+        )
+        return BatchStandardiseResponse.model_validate(data)
+
+    async def geocode(
+        self,
+        address: str,
+        *,
+        mb_category_2021: Optional[List[str]] = None,
+        limit: int = 10,
+    ) -> GeocodeResponse:
+        """Geocode an address to geographic identifiers.
+
+        Args:
+            address: Free-text address string (3-200 characters).
+            mb_category_2021: Mesh-block category filter.
+            limit: Maximum number of results (1-50).
+
+        Returns:
+            A :class:`GeocodeResponse` with geocoded address records.
+        """
+        params = {
+            "address": address,
+            "mb_category_2021": mb_category_2021,
+            "limit": limit,
+        }
+        data = await self._client._request("GET", "/address/geocode", params=params)
+        return GeocodeResponse.model_validate(data)
+
+    async def environment(
+        self,
+        *,
+        address: Optional[str] = None,
+        address_keys: Optional[List[str]] = None,
+        legal_parcel_id: Optional[str] = None,
+        mb_category_2021: Optional[List[str]] = None,
+    ) -> EnvironmentResponse:
+        """Retrieve environmental risk data for an address.
+
+        Exactly one of ``address``, ``address_keys``, or ``legal_parcel_id``
+        must be provided.
+
+        Args:
+            address: Full address string to look up.
+            address_keys: One or more GNAF address keys.
+            legal_parcel_id: Legal parcel identifier.
+            mb_category_2021: Mesh-block category filter.
+
+        Returns:
+            An :class:`EnvironmentResponse` with environment records.
+        """
+        params = {
+            "address": address,
+            "address_keys": address_keys,
+            "legal_parcel_id": legal_parcel_id,
+            "mb_category_2021": mb_category_2021,
+        }
+        data = await self._client._request("GET", "/address/environment", params=params)
+        return EnvironmentResponse.model_validate(data)
+
+    async def demographics(
+        self,
+        *,
+        address: Optional[str] = None,
+        address_keys: Optional[List[str]] = None,
+        legal_parcel_id: Optional[str] = None,
+        mb_category_2021: Optional[List[str]] = None,
+    ) -> DemographicsResponse:
+        """Retrieve demographic indices for an address.
+
+        Exactly one of ``address``, ``address_keys``, or ``legal_parcel_id``
+        must be provided.
+
+        Args:
+            address: Full address string to look up.
+            address_keys: One or more GNAF address keys.
+            legal_parcel_id: Legal parcel identifier.
+            mb_category_2021: Mesh-block category filter.
+
+        Returns:
+            A :class:`DemographicsResponse` with demographic records.
+        """
+        params = {
+            "address": address,
+            "address_keys": address_keys,
+            "legal_parcel_id": legal_parcel_id,
+            "mb_category_2021": mb_category_2021,
+        }
+        data = await self._client._request("GET", "/address/demographics", params=params)
+        return DemographicsResponse.model_validate(data)
+
+    async def schools(
+        self,
+        *,
+        address: Optional[str] = None,
+        address_key: Optional[str] = None,
+        radius_m: Optional[int] = None,
+    ) -> SchoolsResponse:
+        """Retrieve schools relevant to an address.
+
+        Exactly one of ``address`` or ``address_key`` must be provided.
+
+        Args:
+            address: Full address string to look up.
+            address_key: Canonical HTAG address key.
+            radius_m: Search radius in metres for Catholic/Independent schools (1000–50000).
+
+        Returns:
+            A :class:`SchoolsResponse` with school records.
+        """
+        params = {
+            "address": address,
+            "address_key": address_key,
+            "radius_m": radius_m,
+        }
+        data = await self._client._request("GET", "/address/schools", params=params)
+        return SchoolsResponse.model_validate(data)
+
+    async def walkability(
+        self,
+        address_keys: List[str],
+    ) -> AddressWalkabilityResponse:
+        """Retrieve walkability indicators for addresses.
+
+        Args:
+            address_keys: One or more canonical HTAG address keys (max 50).
+
+        Returns:
+            An :class:`AddressWalkabilityResponse` with walkability records.
+        """
+        params = {"address_keys": ",".join(address_keys)}
+        data = await self._client._request("GET", "/address/walkability", params=params)
+        return AddressWalkabilityResponse.model_validate(data)
+
+    async def transport(
+        self,
+        address_keys: List[str],
+    ) -> AddressTransportResponse:
+        """Retrieve public transport proximity for addresses.
+
+        Args:
+            address_keys: One or more canonical HTAG address keys (max 50).
+
+        Returns:
+            An :class:`AddressTransportResponse` with transport records.
+        """
+        params = {"address_keys": ",".join(address_keys)}
+        data = await self._client._request("GET", "/address/transport", params=params)
+        return AddressTransportResponse.model_validate(data)
+
+    async def cbd_proximity(
+        self,
+        address_keys: List[str],
+    ) -> AddressCbdProximityResponse:
+        """Retrieve CBD and major road proximity for addresses.
+
+        Args:
+            address_keys: One or more canonical HTAG address keys (max 50).
+
+        Returns:
+            An :class:`AddressCbdProximityResponse` with CBD proximity records.
+        """
+        params = {"address_keys": ",".join(address_keys)}
+        data = await self._client._request("GET", "/address/cbd-proximity", params=params)
+        return AddressCbdProximityResponse.model_validate(data)
+
+    async def coastal(
+        self,
+        address_keys: List[str],
+    ) -> AddressCoastalResponse:
+        """Retrieve coastal and waterfront proximity for addresses.
+
+        Args:
+            address_keys: One or more canonical HTAG address keys (max 50).
+
+        Returns:
+            An :class:`AddressCoastalResponse` with coastal records.
+        """
+        params = {"address_keys": ",".join(address_keys)}
+        data = await self._client._request("GET", "/address/coastal", params=params)
+        return AddressCoastalResponse.model_validate(data)
+
+    async def green_space(
+        self,
+        address_keys: List[str],
+    ) -> AddressGreenSpaceResponse:
+        """Retrieve parks and recreation proximity for addresses.
+
+        Args:
+            address_keys: One or more canonical HTAG address keys (max 50).
+
+        Returns:
+            An :class:`AddressGreenSpaceResponse` with green space records.
+        """
+        params = {"address_keys": ",".join(address_keys)}
+        data = await self._client._request("GET", "/address/green-space", params=params)
+        return AddressGreenSpaceResponse.model_validate(data)
+
+    async def amenities(
+        self,
+        address_keys: List[str],
+    ) -> AddressAmenitiesResponse:
+        """Retrieve lifestyle amenity proximity for addresses.
+
+        Args:
+            address_keys: One or more canonical HTAG address keys (max 50).
+
+        Returns:
+            An :class:`AddressAmenitiesResponse` with amenity records.
+        """
+        params = {"address_keys": ",".join(address_keys)}
+        data = await self._client._request("GET", "/address/amenities", params=params)
+        return AddressAmenitiesResponse.model_validate(data)
+
+    async def essentials(
+        self,
+        address_keys: List[str],
+    ) -> AddressEssentialsResponse:
+        """Retrieve essential services proximity for addresses.
+
+        Args:
+            address_keys: One or more canonical HTAG address keys (max 50).
+
+        Returns:
+            An :class:`AddressEssentialsResponse` with essential services records.
+        """
+        params = {"address_keys": ",".join(address_keys)}
+        data = await self._client._request("GET", "/address/essentials", params=params)
+        return AddressEssentialsResponse.model_validate(data)
+
+    async def hazards(
+        self,
+        address_keys: List[str],
+    ) -> AddressHazardsResponse:
+        """Retrieve hazard proximity indicators for addresses.
+
+        Args:
+            address_keys: One or more canonical HTAG address keys (max 50).
+
+        Returns:
+            An :class:`AddressHazardsResponse` with hazard records.
+        """
+        params = {"address_keys": ",".join(address_keys)}
+        data = await self._client._request("GET", "/address/hazards", params=params)
+        return AddressHazardsResponse.model_validate(data)
+
+    async def nuisance(
+        self,
+        address_keys: List[str],
+    ) -> AddressNuisanceResponse:
+        """Retrieve nuisance proximity indicators for addresses.
+
+        Args:
+            address_keys: One or more canonical HTAG address keys (max 50).
+
+        Returns:
+            An :class:`AddressNuisanceResponse` with nuisance records.
+        """
+        params = {"address_keys": ",".join(address_keys)}
+        data = await self._client._request("GET", "/address/nuisance", params=params)
+        return AddressNuisanceResponse.model_validate(data)
+
+    async def safety(
+        self,
+        address_keys: List[str],
+    ) -> AddressSafetyResponse:
+        """Retrieve emergency services proximity for addresses.
+
+        Args:
+            address_keys: One or more canonical HTAG address keys (max 50).
+
+        Returns:
+            An :class:`AddressSafetyResponse` with safety records.
+        """
+        params = {"address_keys": ",".join(address_keys)}
+        data = await self._client._request("GET", "/address/safety", params=params)
+        return AddressSafetyResponse.model_validate(data)
+
+    async def aviation(
+        self,
+        address_keys: List[str],
+    ) -> AddressAviationResponse:
+        """Retrieve aviation flight path indicators for addresses.
+
+        Args:
+            address_keys: One or more canonical HTAG address keys (max 50).
+
+        Returns:
+            An :class:`AddressAviationResponse` with aviation records.
+        """
+        params = {"address_keys": ",".join(address_keys)}
+        data = await self._client._request("GET", "/address/aviation", params=params)
+        return AddressAviationResponse.model_validate(data)
+
+    async def road_infrastructure(
+        self,
+        address_keys: List[str],
+    ) -> AddressRoadInfrastructureResponse:
+        """Retrieve road infrastructure indicators for addresses.
+
+        Args:
+            address_keys: One or more canonical HTAG address keys (max 50).
+
+        Returns:
+            An :class:`AddressRoadInfrastructureResponse` with road infrastructure records.
+        """
+        params = {"address_keys": ",".join(address_keys)}
+        data = await self._client._request(
+            "GET", "/address/road-infrastructure", params=params
+        )
+        return AddressRoadInfrastructureResponse.model_validate(data)