htag-sdk 0.7.1 → 0.8.1

package/dist/index.d.ts

@@ -178,6 +178,94 @@ interface StandardisedAddress {
 interface BatchStandardiseResponse {
     results: StandardisedAddress[];
 }
+interface GeocodeParams extends RequestOptions {
+    /** Free-text address string (3-200 characters). */
+    address: string;
+    /** Mesh block category 2021 filter. */
+    mbCategory2021?: string[];
+    /** Maximum number of results (1-50). */
+    limit?: number;
+}
+interface GeocodeRecord {
+    address_key?: string | null;
+    gnaf_property_pid?: string | null;
+    legal_parcel_id?: string | null;
+    loc_pid?: string | null;
+    sa1_code21?: string | null;
+    sa2_code21?: string | null;
+    lga_pid?: string | null;
+    sa4_name21?: string | null;
+    gcc_name21?: string | null;
+    mb_category?: string | null;
+    lat?: number | null;
+    lon?: number | null;
+    suburb_slug?: string | null;
+    address_label?: string | null;
+    address_site_name?: string | null;
+    building_name?: string | null;
+    flat_type?: string | null;
+    flat_number?: string | null;
+    level_type?: string | null;
+    level_number?: string | null;
+    number_first?: string | null;
+    number_last?: string | null;
+    lot_number?: string | null;
+    street_name?: string | null;
+    street_type?: string | null;
+    street_suffix?: string | null;
+    locality_name?: string | null;
+    state?: string | null;
+    postcode?: string | null;
+}
+interface GeocodeResponse {
+    total: number;
+    results: GeocodeRecord[];
+}
+interface EnvironmentParams extends RequestOptions {
+    /** Free-text address to look up. */
+    address?: string;
+    /** One or more GNAF address keys. */
+    addressKeys?: string[];
+    /** Legal parcel identifier. */
+    legalParcelId?: string;
+    /** Mesh block category 2021. */
+    mbCategory2021?: string[];
+}
+interface EnvironmentRecord {
+    address_key?: string | null;
+    flood?: boolean | null;
+    bushfire?: boolean | null;
+    heritage?: boolean | null;
+    zoning?: string | null;
+}
+interface EnvironmentResponse {
+    total: number;
+    results: EnvironmentRecord[];
+}
+interface DemographicsParams extends RequestOptions {
+    /** Free-text address to look up. */
+    address?: string;
+    /** One or more GNAF address keys. */
+    addressKeys?: string[];
+    /** Legal parcel identifier. */
+    legalParcelId?: string;
+    /** Mesh block category 2021. */
+    mbCategory2021?: string[];
+}
+interface DemographicsRecord {
+    address_key?: string | null;
+    IRSD?: number | null;
+    IRSAD?: number | null;
+    IER?: number | null;
+    IEO?: number | null;
+    public_housing?: number | null;
+    private_rentals?: number | null;
+}
+interface DemographicsResponse {
+    total: number;
+    results: DemographicsRecord[];
+    attribution?: string | null;
+}
 
 /**
  * Client for the Address API domain.
@@ -199,7 +287,7 @@ declare class AddressClient {
     /**
      * Retrieve detailed insights for one or more addresses.
      *
-     * `GET /v1/address/insights`
+     * `GET /internal-api/v1/address/insights`
      */
     insights(params: AddressInsightsParams): Promise<AddressInsightsResponse>;
     /**
@@ -208,6 +296,24 @@ declare class AddressClient {
      * `POST /v1/address/standardise`
      */
     standardise(params: BatchStandardiseParams): Promise<BatchStandardiseResponse>;
+    /**
+     * Geocode an address string to structured location data.
+     *
+     * `GET /v1/address/geocode`
+     */
+    geocode(params: GeocodeParams): Promise<GeocodeResponse>;
+    /**
+     * Retrieve environmental data (flood, bushfire, heritage, zoning) for addresses.
+     *
+     * `GET /v1/address/environment`
+     */
+    environment(params: EnvironmentParams): Promise<EnvironmentResponse>;
+    /**
+     * Retrieve demographic data (SEIFA indices, housing tenure) for addresses.
+     *
+     * `GET /v1/address/demographics`
+     */
+    demographics(params: DemographicsParams): Promise<DemographicsResponse>;
 }
 
 interface SoldPropertyRecord {
@@ -524,6 +630,221 @@ type HoldPeriodResponse = BaseResponse<FSDYearlyOut>;
 type PerformanceResponse = BaseResponse<EssentialsOut>;
 type GrowthRatesResponse = BaseResponse<GRCOut>;
 type DemandProfileResponse = BaseResponse<DemandProfileOut>;
+interface MarketSnapshotParams extends RequestOptions {
+    level: LevelEnum;
+    areaId: string[];
+    propertyType?: PropertyTypeEnum[];
+    limit?: number;
+    offset?: number;
+}
+interface MarketGrowthCumulativeRecord {
+    area_id?: string | null;
+    period_end?: string | null;
+    property_type?: string | null;
+    price_1m_growth?: number | null;
+    price_1q_growth?: number | null;
+    price_6m_growth?: number | null;
+    price_1y_growth?: number | null;
+    price_3y_growth?: number | null;
+    price_5y_growth?: number | null;
+    price_10y_growth?: number | null;
+    rent_1m_growth?: number | null;
+    rent_1q_growth?: number | null;
+    rent_6m_growth?: number | null;
+    rent_1y_growth?: number | null;
+    rent_3y_growth?: number | null;
+    rent_5y_growth?: number | null;
+    rent_10y_growth?: number | null;
+    yield_1m_growth?: number | null;
+    yield_1q_growth?: number | null;
+    yield_6m_growth?: number | null;
+    yield_1y_growth?: number | null;
+    yield_3y_growth?: number | null;
+    yield_5y_growth?: number | null;
+    yield_10y_growth?: number | null;
+}
+interface MarketGrowthAnnualisedRecord {
+    area_id?: string | null;
+    period_end?: string | null;
+    property_type?: string | null;
+    price_1y_growth_annualised?: number | null;
+    price_3y_growth_annualised?: number | null;
+    price_5y_growth_annualised?: number | null;
+    price_10y_growth_annualised?: number | null;
+    rent_1m_growth_annualised?: number | null;
+    rent_1q_growth_annualised?: number | null;
+    rent_6m_growth_annualised?: number | null;
+    rent_1y_growth_annualised?: number | null;
+    rent_3y_growth_annualised?: number | null;
+    rent_5y_growth_annualised?: number | null;
+    rent_10y_growth_annualised?: number | null;
+    yield_1y_growth_annualised?: number | null;
+    yield_3y_growth_annualised?: number | null;
+    yield_5y_growth_annualised?: number | null;
+    yield_10y_growth_annualised?: number | null;
+}
+interface MarketSupplyRecord {
+    area_id?: string | null;
+    period_end?: string | null;
+    property_type?: string | null;
+    som_percent?: number | null;
+    inventory?: number | null;
+    building_approvals_estimated?: number | null;
+    ba_ratio?: number | null;
+    hold_period?: number | null;
+}
+interface MarketSupplyLongSlopeRecord {
+    area_id?: string | null;
+    period_end?: string | null;
+    property_type?: string | null;
+    ls_som_perc?: number | null;
+    ls_inventory?: number | null;
+    ls_hold_period?: number | null;
+}
+interface MarketSupplyShortSlopeRecord {
+    area_id?: string | null;
+    period_end?: string | null;
+    property_type?: string | null;
+    ss_som_perc?: number | null;
+    ss_inventory?: number | null;
+    ss_hold_period?: number | null;
+}
+interface MarketDemandRecord {
+    area_id?: string | null;
+    period_end?: string | null;
+    property_type?: string | null;
+    dom?: number | null;
+    discounting?: number | null;
+    vacancy_rate?: number | null;
+    vacancies?: number | null;
+    dorm?: number | null;
+    clearance_rate?: number | null;
+    auctions?: number | null;
+    buy_si?: number | null;
+    rent_si?: number | null;
+}
+interface MarketDemandLongSlopeRecord {
+    area_id?: string | null;
+    period_end?: string | null;
+    property_type?: string | null;
+    ls_dom?: number | null;
+    ls_discounting?: number | null;
+    ls_vacancy_rate?: number | null;
+    ls_clearance_rate?: number | null;
+    ls_buy_si?: number | null;
+    ls_rent_si?: number | null;
+}
+interface MarketDemandShortSlopeRecord {
+    area_id?: string | null;
+    period_end?: string | null;
+    property_type?: string | null;
+    ss_dom?: number | null;
+    ss_discounting?: number | null;
+    ss_vacancy_rate?: number | null;
+    ss_clearance_rate?: number | null;
+    ss_buy_si?: number | null;
+    ss_rent_si?: number | null;
+}
+interface MarketScoresRecord {
+    area_id?: string | null;
+    period_end?: string | null;
+    property_type?: string | null;
+    rcs_lower_risk?: number | null;
+    rcs_cashflow?: number | null;
+    rcs_capital_growth?: number | null;
+    rcs_overall?: number | null;
+    hapi_score?: number | null;
+    volatility_index?: number | null;
+}
+interface MarketFundamentalsRecord {
+    area_id?: string | null;
+    period_end?: string | null;
+    property_type?: string | null;
+    irsad?: number | null;
+    ro_ratio?: number | null;
+    uh_ratio?: number | null;
+    uhv_ratio?: number | null;
+    years_to_own?: number | null;
+}
+interface MarketCycleRecord {
+    area_id?: string | null;
+    period_end?: string | null;
+    property_type?: string | null;
+    growth_rate_cycle?: string | null;
+    grc_price_index?: number | null;
+    min_grc?: number | null;
+    gpd_3?: number | null;
+    gpd_5?: number | null;
+    gpd_10?: number | null;
+    gsp_3?: number | null;
+    gsp_5?: number | null;
+    gsp_10?: number | null;
+    projected_annual_capital_growth_low?: number | null;
+    projected_annual_capital_growth_high?: number | null;
+    projected_annual_rent_increase?: number | null;
+    projected_annual_roi_low?: number | null;
+    projected_annual_roi_high?: number | null;
+}
+interface MarketRiskRecord {
+    area_id?: string | null;
+    period_end?: string | null;
+    property_type?: string | null;
+    hrp_flood?: number | null;
+    hrp_fire?: number | null;
+    ediv_ind?: number | null;
+    madi?: number | null;
+    gpo_dist?: number | null;
+}
+type GrowthCumulativeResponse = BaseResponse<MarketGrowthCumulativeRecord>;
+type GrowthAnnualisedResponse = BaseResponse<MarketGrowthAnnualisedRecord>;
+type MarketSupplyResponse = BaseResponse<MarketSupplyRecord>;
+type SupplyLongSlopeResponse = BaseResponse<MarketSupplyLongSlopeRecord>;
+type SupplyShortSlopeResponse = BaseResponse<MarketSupplyShortSlopeRecord>;
+type MarketDemandResponse = BaseResponse<MarketDemandRecord>;
+type DemandLongSlopeResponse = BaseResponse<MarketDemandLongSlopeRecord>;
+type DemandShortSlopeResponse = BaseResponse<MarketDemandShortSlopeRecord>;
+type MarketScoresResponse = BaseResponse<MarketScoresRecord>;
+type MarketFundamentalsResponse = BaseResponse<MarketFundamentalsRecord>;
+type MarketCycleResponse = BaseResponse<MarketCycleRecord>;
+type MarketRiskResponse = BaseResponse<MarketRiskRecord>;
+interface StockOnMarketTrendRecord {
+    area_id: string;
+    period_end: string;
+    property_type: string;
+    som: number | null;
+    som_percent: number | null;
+}
+interface InventoryTrendRecord {
+    area_id: string;
+    period_end: string;
+    property_type: string;
+    inventory: number | null;
+}
+interface DaysOnMarketTrendRecord {
+    area_id: string;
+    period_end: string;
+    property_type: string;
+    dom: number | null;
+    discounting: number | null;
+}
+interface ClearanceRateTrendRecord {
+    area_id: string;
+    period_end: string;
+    property_type: string;
+    clearance_rate: number | null;
+    scheduled: number | null;
+}
+interface VacancyTrendRecord {
+    area_id: string;
+    period_end: string;
+    property_type: string;
+    vacancy_rate: number | null;
+}
+type StockOnMarketResponse = BaseResponse<StockOnMarketTrendRecord>;
+type InventoryTrendResponse = BaseResponse<InventoryTrendRecord>;
+type DaysOnMarketResponse = BaseResponse<DaysOnMarketTrendRecord>;
+type ClearanceRateResponse = BaseResponse<ClearanceRateTrendRecord>;
+type VacancyResponse = BaseResponse<VacancyTrendRecord>;
 
 /**
  * Client for the Markets Trends API domain.
@@ -596,6 +917,36 @@ declare class TrendsClient {
      * `GET /v1/markets/trends/demand-profile`
      */
     demandProfile(params: TrendsParams): Promise<DemandProfileResponse>;
+    /**
+     * Stock on market trends.
+     *
+     * `GET /v1/markets/trends/stock-on-market`
+     */
+    stockOnMarket(params: TrendsParams): Promise<StockOnMarketResponse>;
+    /**
+     * Inventory trends.
+     *
+     * `GET /v1/markets/trends/inventory`
+     */
+    inventory(params: TrendsParams): Promise<InventoryTrendResponse>;
+    /**
+     * Days on market trends.
+     *
+     * `GET /v1/markets/trends/days-on-market`
+     */
+    daysOnMarket(params: TrendsParams): Promise<DaysOnMarketResponse>;
+    /**
+     * Clearance rate trends.
+     *
+     * `GET /v1/markets/trends/clearance-rate`
+     */
+    clearanceRate(params: TrendsParams): Promise<ClearanceRateResponse>;
+    /**
+     * Vacancy rate trends.
+     *
+     * `GET /v1/markets/trends/vacancy`
+     */
+    vacancy(params: TrendsParams): Promise<VacancyResponse>;
     private trend;
     private publicTrend;
 }
@@ -633,6 +984,78 @@ declare class MarketsClient {
      * `POST /internal-api/v1/markets/query`
      */
     query(body: AdvancedSearchBody, options?: RequestOptions): Promise<MarketQueryResponse>;
+    /**
+     * Cumulative growth metrics.
+     *
+     * `GET /v1/markets/growth/cumulative`
+     */
+    growthCumulative(params: MarketSnapshotParams): Promise<GrowthCumulativeResponse>;
+    /**
+     * Annualised growth metrics.
+     *
+     * `GET /v1/markets/growth/annualised`
+     */
+    growthAnnualised(params: MarketSnapshotParams): Promise<GrowthAnnualisedResponse>;
+    /**
+     * Supply metrics.
+     *
+     * `GET /v1/markets/supply`
+     */
+    supply(params: MarketSnapshotParams): Promise<MarketSupplyResponse>;
+    /**
+     * Supply long-term slope metrics.
+     *
+     * `GET /v1/markets/supply/ls`
+     */
+    supplyLongSlope(params: MarketSnapshotParams): Promise<SupplyLongSlopeResponse>;
+    /**
+     * Supply short-term slope metrics.
+     *
+     * `GET /v1/markets/supply/ss`
+     */
+    supplyShortSlope(params: MarketSnapshotParams): Promise<SupplyShortSlopeResponse>;
+    /**
+     * Demand metrics.
+     *
+     * `GET /v1/markets/demand`
+     */
+    demand(params: MarketSnapshotParams): Promise<MarketDemandResponse>;
+    /**
+     * Demand long-term slope metrics.
+     *
+     * `GET /v1/markets/demand/ls`
+     */
+    demandLongSlope(params: MarketSnapshotParams): Promise<DemandLongSlopeResponse>;
+    /**
+     * Demand short-term slope metrics.
+     *
+     * `GET /v1/markets/demand/ss`
+     */
+    demandShortSlope(params: MarketSnapshotParams): Promise<DemandShortSlopeResponse>;
+    /**
+     * Market scores (RCS, HAPI, volatility).
+     *
+     * `GET /v1/markets/scores`
+     */
+    scores(params: MarketSnapshotParams): Promise<MarketScoresResponse>;
+    /**
+     * Market fundamentals (IRSAD, ratios, years to own).
+     *
+     * `GET /v1/markets/fundamentals`
+     */
+    fundamentals(params: MarketSnapshotParams): Promise<MarketFundamentalsResponse>;
+    /**
+     * Market cycle indicators.
+     *
+     * `GET /v1/markets/cycle`
+     */
+    cycle(params: MarketSnapshotParams): Promise<MarketCycleResponse>;
+    /**
+     * Market risk indicators (flood, fire, diversity, distance).
+     *
+     * `GET /v1/markets/risk`
+     */
+    risk(params: MarketSnapshotParams): Promise<MarketRiskResponse>;
 }
 
 type SourceType = 'AGENT' | 'PLATFORM' | 'PARTNER' | 'INTERNAL';
@@ -882,6 +1305,49 @@ declare class IntentHubClient {
     listTags(options?: RequestOptions): Promise<TagInfo[]>;
 }
 
+interface LocalityParams extends RequestOptions {
+    locPid?: string;
+    stateName?: string;
+    lgaPid?: string;
+    limit?: number;
+    offset?: number;
+}
+interface LocalityRecord {
+    loc_pid?: string | null;
+    locality?: string | null;
+    postcode?: string | null;
+    state_name?: string | null;
+    suburb_key?: string | null;
+    lga_pid_ref?: string | null;
+}
+interface LocalityResponse {
+    total: number;
+    results: LocalityRecord[];
+}
+interface LgaParams extends RequestOptions {
+    stateName?: string;
+    lgaPid?: string;
+    limit?: number;
+    offset?: number;
+}
+interface LgaRecord {
+    lga_pid?: string | null;
+    lga_name?: string | null;
+    state_name?: string | null;
+    lga_key?: string | null;
+}
+interface LgaResponse {
+    total: number;
+    results: LgaRecord[];
+}
+
+declare class ReferenceClient {
+    private readonly http;
+    constructor(http: HttpClient);
+    locality(params: LocalityParams): Promise<LocalityResponse>;
+    lga(params: LgaParams): Promise<LgaResponse>;
+}
+
 /**
  * Top-level client for the HtAG Location Intelligence APIs.
  *
@@ -905,6 +1371,8 @@ declare class HtAgApiClient {
     readonly markets: MarketsClient;
     /** Intent Hub: event classification, integrations and subscriptions. */
     readonly intentHub: IntentHubClient;
+    /** Reference data: localities and LGAs. */
+    readonly reference: ReferenceClient;
     constructor(options: HtAgClientOptions);
 }
 
@@ -965,4 +1433,4 @@ declare class ServerError extends HtAgError {
     });
 }
 
-export { AddressClient, type AddressInsightsParams, type AddressInsightsResponse, type AddressRecord, type AddressSearchParams, type AddressSearchResponse, type AddressSearchResult, type AdvancedSearchBody, AuthenticationError, type BaseResponse, type BatchStandardiseParams, type BatchStandardiseResponse, type ClassifiedEvent, type CreateIntegrationParams, type CreateSubscriptionParams, type DemandProfileOut, type DemandProfileResponse, type EssentialsOut, type EventCategory, type EventType, type FSDMonthlyOut, type FSDQuarterlyOut, type FSDYearlyOut, type GRCOut, type GrowthRatesResponse, type HoldPeriodResponse, HtAgApiClient, type HtAgClientOptions, HtAgError, type Integration, type IntegrationStatus, type IntegrationType, IntentHubClient, type LevelEnum, type LogicNode, type MarketQueryParams, type MarketQueryResponse, type MarketSnapshot, MarketsClient, type PaginatedEvents, type PerformanceResponse, type PriceHistoryOut, type PriceResponse, PropertyClient, type PropertyTypeEnum, type QueryEventsParams, RateLimitError, type RentHistoryOut, type RentResponse, type RequestOptions, type ResolvedConfig, type SearchIndexResponse, type Sentiment, ServerError, type SnapshotsParams, type SnapshotsResponse, type SoldPropertiesResponse, type SoldPropertyRecord, type SoldSearchParams, type SourceType, type StandardisedAddress, type SubmitEventParams, type Subscription, type SupplyDemandResponse, type TagInfo, type TestResult, TrendsClient, type TrendsParams, type TrendsWithBedroomsParams, type UpdateIntegrationParams, type UpdateSubscriptionParams, type Urgency, ValidationError, type YieldHistoryOut, type YieldResponse };
+export { AddressClient, type AddressInsightsParams, type AddressInsightsResponse, type AddressRecord, type AddressSearchParams, type AddressSearchResponse, type AddressSearchResult, type AdvancedSearchBody, AuthenticationError, type BaseResponse, type BatchStandardiseParams, type BatchStandardiseResponse, type ClassifiedEvent, type ClearanceRateResponse, type ClearanceRateTrendRecord, type CreateIntegrationParams, type CreateSubscriptionParams, type DaysOnMarketResponse, type DaysOnMarketTrendRecord, type DemandLongSlopeResponse, type DemandProfileOut, type DemandProfileResponse, type DemandShortSlopeResponse, type DemographicsParams, type DemographicsRecord, type DemographicsResponse, type EnvironmentParams, type EnvironmentRecord, type EnvironmentResponse, type EssentialsOut, type EventCategory, type EventType, type FSDMonthlyOut, type FSDQuarterlyOut, type FSDYearlyOut, type GRCOut, type GeocodeParams, type GeocodeRecord, type GeocodeResponse, type GrowthAnnualisedResponse, type GrowthCumulativeResponse, type GrowthRatesResponse, type HoldPeriodResponse, HtAgApiClient, type HtAgClientOptions, HtAgError, type Integration, type IntegrationStatus, type IntegrationType, IntentHubClient, type InventoryTrendRecord, type InventoryTrendResponse, type LevelEnum, type LgaParams, type LgaRecord, type LgaResponse, type LocalityParams, type LocalityRecord, type LocalityResponse, type LogicNode, type MarketCycleRecord, type MarketCycleResponse, type MarketDemandLongSlopeRecord, type MarketDemandRecord, type MarketDemandResponse, type MarketDemandShortSlopeRecord, type MarketFundamentalsRecord, type MarketFundamentalsResponse, type MarketGrowthAnnualisedRecord, type MarketGrowthCumulativeRecord, type MarketQueryParams, type MarketQueryResponse, type MarketRiskRecord, type MarketRiskResponse, type MarketScoresRecord, type MarketScoresResponse, type MarketSnapshot, type MarketSnapshotParams, type MarketSupplyLongSlopeRecord, type MarketSupplyRecord, type MarketSupplyResponse, type MarketSupplyShortSlopeRecord, MarketsClient, type PaginatedEvents, type PerformanceResponse, type PriceHistoryOut, type PriceResponse, PropertyClient, type PropertyTypeEnum, type QueryEventsParams, RateLimitError, ReferenceClient, type RentHistoryOut, type RentResponse, type RequestOptions, type ResolvedConfig, type SearchIndexResponse, type Sentiment, ServerError, type SnapshotsParams, type SnapshotsResponse, type SoldPropertiesResponse, type SoldPropertyRecord, type SoldSearchParams, type SourceType, type StandardisedAddress, type StockOnMarketResponse, type StockOnMarketTrendRecord, type SubmitEventParams, type Subscription, type SupplyDemandResponse, type SupplyLongSlopeResponse, type SupplyShortSlopeResponse, type TagInfo, type TestResult, TrendsClient, type TrendsParams, type TrendsWithBedroomsParams, type UpdateIntegrationParams, type UpdateSubscriptionParams, type Urgency, type VacancyResponse, type VacancyTrendRecord, ValidationError, type YieldHistoryOut, type YieldResponse };