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

    Interface Building

    A building represented as JSON-LD following the Kikai Standard v1 schema.

    This is the full building record returned by detail endpoints like buildings.getById() and portfolios.get(). It conforms to schema.org/Building with Plentiful vocabulary extensions for energy data, owner enrichment, and ML predictions.

    Key fields:

    • address — physical location of the building
    • geo — WGS 84 coordinates and elevation
    • owner — property owner name and classification
    • floorSize — total floor area in square feet
    • yearBuilt — four-digit construction year
    • additionalProperty — extensible array of typed properties including occupancy class, HVAC details, energy predictions, and owner enrichment
    • permit — construction permit history
    interface Building {
        "@context"?: Record<string, unknown>;
        "@id"?: string;
        "@type"?: string;
        additionalProperty?: PropertyValue[];
        address?:
            | {
                "@type"?: string;
                addressCountry?: string
                | null;
                addressLocality?: string | null;
                addressRegion?: string | null;
                postalCode?: string | null;
                streetAddress?: string | null;
            }
            | null;
        description?: string
        | null;
        floorSize?:
            | { "@type"?: string; unitCode?: string; value?: number
            | null }
            | null;
        geo?:
            | {
                "@type"?: string;
                elevation?: { unitCode?: string; value?: number | null }
                | null;
                latitude?: number | null;
                longitude?: number | null;
            }
            | null;
        identifier?: PropertyValue[];
        mailingAddress?: | {
            "@type"?: string;
            addressLocality?: string
            | null;
            addressRegion?: string | null;
            postalCode?: string | null;
            streetAddress?: string | null;
        }
        | null;
        name?: string
        | null;
        owner?:
            | {
                "@type"?: string;
                name?: string
                | null;
                "plentiful:ownerType"?: string | null;
            }
            | null;
        permit?: unknown[];
        potentialAction?: unknown[];
        sameAs?: string[];
        yearBuilt?: number
        | null;
    }
    Index

    Properties

    @context? @id? @type? additionalProperty? address? description? floorSize? geo? identifier? mailingAddress? name? owner? permit? potentialAction? sameAs? yearBuilt?

    Properties

    "@context"?: Record<string, unknown>

    JSON-LD context declaring vocabulary prefixes.

    "@id"?: string

    Canonical URL identifier (e.g. "https://plentiful.ai/buildings/{uuid}").

    "@type"?: string

    Always "Building".

    additionalProperty?: PropertyValue[]

    Extensible array of building properties — occupancy class, HVAC details, energy predictions, physical characteristics, utility info, and owner enrichment. Use the name field to find specific properties.

    address?:
        | {
            "@type"?: string;
            addressCountry?: string
            | null;
            addressLocality?: string | null;
            addressRegion?: string | null;
            postalCode?: string | null;
            streetAddress?: string | null;
        }
        | null

    Physical street address of the building.

    Type Declaration

    • {
          "@type"?: string;
          addressCountry?: string | null;
          addressLocality?: string | null;
          addressRegion?: string | null;
          postalCode?: string | null;
          streetAddress?: string | null;
      }
      • Optional@type?: string
      • OptionaladdressCountry?: string | null

        ISO 3166-1 alpha-2 country code (e.g. "US").

      • OptionaladdressLocality?: string | null
      • OptionaladdressRegion?: string | null

        ISO 3166-2 state/province code (e.g. "PA", "NY").

      • OptionalpostalCode?: string | null
      • OptionalstreetAddress?: string | null
    • null
    description?: string | null

    Optional free-text description.

    floorSize?:
        | { "@type"?: string; unitCode?: string; value?: number
        | null }
        | null

    Total floor area. unitCode: "FTK" = square feet.

    geo?:
        | {
            "@type"?: string;
            elevation?: { unitCode?: string; value?: number | null }
            | null;
            latitude?: number | null;
            longitude?: number | null;
        }
        | null

    Geographic coordinates (WGS 84) and optional elevation.

    Type Declaration

    • {
          "@type"?: string;
          elevation?: { unitCode?: string; value?: number | null } | null;
          latitude?: number | null;
          longitude?: number | null;
      }
      • Optional@type?: string
      • Optionalelevation?: { unitCode?: string; value?: number | null } | null

        Elevation above sea level.

      • Optionallatitude?: number | null

        Latitude in decimal degrees.

      • Optionallongitude?: number | null

        Longitude in decimal degrees.

    • null
    identifier?: PropertyValue[]

    Building identifiers — typically includes UBID and Plentiful UUID.

    mailingAddress?:
        | {
            "@type"?: string;
            addressLocality?: string
            | null;
            addressRegion?: string | null;
            postalCode?: string | null;
            streetAddress?: string | null;
        }
        | null

    Owner's mailing address — may differ from the building's physical address.

    name?: string | null

    Human-readable building name, usually derived from the street address.

    owner?:
        | {
            "@type"?: string;
            name?: string
            | null;
            "plentiful:ownerType"?: string | null;
        }
        | null

    Property owner information.

    Type Declaration

    • {
          "@type"?: string;
          name?: string | null;
          "plentiful:ownerType"?: string | null;
      }
      • Optional@type?: string
      • Optionalname?: string | null

        Owner name as recorded by the county assessor.

      • Optionalplentiful:ownerType?: string | null

        Owner classification (e.g. "REGULAR-ETAL", "CORPORATION", "GOVERNMENT").

    • null
    permit?: unknown[]

    Construction permit history.

    potentialAction?: unknown[]

    Placeholder for future upgrade recommendation actions.

    sameAs?: string[]

    URLs linking to this building in other databases.

    yearBuilt?: number | null

    Four-digit construction year.

    Settings

    Member Visibility

    On This Page

    Properties