@project-niffler/kikai-client
    Preparing search index...

    Interface ListBuildingsParams

    Filter and pagination parameters for the building list endpoint.

    interface ListBuildingsParams {
        buildingType?: string;
        maxUnits?: number;
        maxYear?: number;
        minUnits?: number;
        minYear?: number;
        occupancyClass?: string;
        owner?: string;
        ownerTypeGroup?: string;
        page?: number;
        pageSize?: number;
        zipCode?: string;
    }
    Index

    Properties

    buildingType? maxUnits? maxYear? minUnits? minYear? occupancyClass? owner? ownerTypeGroup? page? pageSize? zipCode?

    Properties

    buildingType?: string

    Filter by ComStock building type (e.g. "MediumOffice").

    maxUnits?: number

    Maximum number of units.

    maxYear?: number

    Maximum construction year.

    minUnits?: number

    Minimum number of units.

    minYear?: number

    Minimum construction year.

    occupancyClass?: string

    Filter by occupancy class (e.g. "Commercial", "Residential").

    owner?: string

    Filter by owner name (exact match).

    ownerTypeGroup?: string

    Filter by owner type group ("CORPORATION" or "REGULAR").

    Optionalpage

    page?: number

    Page number (1-based).

    pageSize?: number

    Results per page (max 100).

    zipCode?: string

    Filter by ZIP code.

    Settings

    Member Visibility

    On This Page

    Properties