@cercalia/sdk
    Preparing search index...

    Interface GeocodingCandidate

    Represents a geocoding result from the Cercalia API.

    This interface follows the SDK's Golden Rules:

    • No administrative fallbacks (fields will be null if API returns null)
    • All administrative IDs are extracted alongside their names
    • Coordinates are validated before mapping
    interface GeocodingCandidate {
        coord: Coordinate;
        country?: string;
        countryCode?: string;
        district?: string;
        districtCode?: string;
        houseNumber?: string;
        id: string;
        label?: string;
        level?: GeocodingLevel;
        locality?: string;
        localityCode?: string;
        municipality?: string;
        municipalityCode?: string;
        name: string;
        postalCode?: string;
        region?: string;
        regionCode?: string;
        street?: string;
        streetCode?: string;
        subregion?: string;
        subregionCode?: string;
        type: GeocodingCandidateType;
    }
    Index

    Properties

    coord country? countryCode? district? districtCode? houseNumber? id label? level? locality? localityCode? municipality? municipalityCode? name postalCode? region? regionCode? street? streetCode? subregion? subregionCode? type

    Properties

    coord: Coordinate

    Geographic coordinates. Never null after validation.

    country?: string

    Country name.

    countryCode for the corresponding ID.

    countryCode?: string

    ISO country code or Cercalia country identifier.

    district?: string

    District name.

    districtCode for the corresponding ID.

    districtCode?: string

    Cercalia district identifier.

    houseNumber?: string

    House number for street addresses.

    id: string

    Unique Cercalia identifier for this location.

    label?: string

    Full formatted label for the location.

    level?: GeocodingLevel

    The Cercalia level code (from

    locality?: string

    City or locality name.

    localityCode for the corresponding ID.

    localityCode?: string

    Cercalia locality identifier.

    municipality?: string

    Municipality name.

    municipalityCode for the corresponding ID.

    municipalityCode?: string

    Cercalia municipality identifier.

    name: string

    Display name of the location.

    postalCode?: string

    Postal code.

    region?: string

    Region name.

    regionCode for the corresponding ID.

    regionCode?: string

    Cercalia region identifier.

    street?: string

    Street name.

    streetCode for the corresponding ID.

    streetCode?: string

    Cercalia street identifier.

    subregion?: string

    Sub-region (province) name.

    subregionCode for the corresponding ID.

    subregionCode?: string

    Cercalia sub-region identifier.

    type: GeocodingCandidateType

    The type of candidate (address, street, poi, etc.).

    Settings

    Member Visibility

    On This Page

    Properties