@cercalia/sdk
    Preparing search index...

    Interface SuggestResult

    Normalized suggestion result from Cercalia Suggest API

    GOLDEN RULES COMPLIANCE:

    • Uses *Code suffix for all identifiers (not *Id)
    • Direct 1:1 mapping from API fields
    • No fallbacks between administrative levels
    interface SuggestResult {
        city?: {
            bracketLocality?: string | null;
            code: string | null;
            name: string | null;
        };
        coord?: Coordinate;
        country?: { code: string
        | null; name: string | null };
        displayText: string;
        houseNumbers?: {
            adjusted?: number | null;
            available: boolean;
            current?: number | null;
            hint?: string | null;
            isEnglishFormat?: boolean;
            max?: number | null;
            min?: number | null;
        };
        id: string;
        isOfficial?: boolean;
        municipality?: { code: string
        | null; name: string | null };
        poi?: {
            categoryCode?: string | null;
            code: string | null;
            name: string | null;
        };
        postalCode?: string
        | null;
        region?: { code: string | null; name: string | null };
        score?: number;
        street?: {
            article: string | null;
            code: string | null;
            description: string | null;
            name: string | null;
            type: string | null;
        };
        subregion?: { code: string
        | null; name: string | null };
        type: "address" | "street" | "poi" | "city";
    }
    Index

    Properties

    city? coord? country? displayText houseNumbers? id isOfficial? municipality? poi? postalCode? region? score? street? subregion? type

    Properties

    city?: {
        bracketLocality?: string | null;
        code: string | null;
        name: string | null;
    }

    City/Locality information (from localidad_* fields)

    coord?: Coordinate

    Coordinates (from coord field, format: "lat,lng")

    country?: { code: string | null; name: string | null }

    Country information (from pais_* fields)

    displayText: string

    Human-readable display text built from address components

    houseNumbers?: {
        adjusted?: number | null;
        available: boolean;
        current?: number | null;
        hint?: string | null;
        isEnglishFormat?: boolean;
        max?: number | null;
        min?: number | null;
    }

    House number information for streets

    id: string

    Unique identifier for this suggestion (from API 'id' field)

    isOfficial?: boolean

    Whether this is an official name (from 'oficial' field)

    municipality?: { code: string | null; name: string | null }

    Municipality information (from municipio_* fields)

    poi?: { categoryCode?: string | null; code: string | null; name: string | null }

    POI specific data

    postalCode?: string | null

    Postal code (from codigo_postal field)

    region?: { code: string | null; name: string | null }

    Region/Community information (from comunidad_* fields)

    score?: number

    Relevance score from search (from 'score' field)

    street?: {
        article: string | null;
        code: string | null;
        description: string | null;
        name: string | null;
        type: string | null;
    }

    Street information (from calle_* fields)

    subregion?: { code: string | null; name: string | null }

    Subregion/Province information (from provincia_* fields)

    type: "address" | "street" | "poi" | "city"

    Type of suggestion: street, city, poi, or address

    Settings

    Member Visibility

    On This Page

    Properties