@cercalia/sdk
    Preparing search index...

    Interface SuggestGeocodeResult

    Geocoded result from Cercalia Suggest Geocode API

    GOLDEN RULES COMPLIANCE:

    • Uses *Code suffix for all identifiers (not *Id)
    • Every administrative name has its corresponding code
    • Coordinates are required (strict)
    interface SuggestGeocodeResult {
        cityCode?: string | null;
        cityName?: string | null;
        coord: Coordinate;
        countryCode?: string | null;
        countryName?: string | null;
        formattedAddress: string;
        houseNumber?: string | null;
        municipalityCode?: string | null;
        municipalityName?: string | null;
        name?: string | null;
        postalCode?: string | null;
        regionCode?: string | null;
        regionName?: string | null;
        streetCode?: string | null;
        streetName?: string | null;
        subregionCode?: string | null;
        subregionName?: string | null;
    }
    Index

    Properties

    cityCode? cityName? coord countryCode? countryName? formattedAddress houseNumber? municipalityCode? municipalityName? name? postalCode? regionCode? regionName? streetCode? streetName? subregionCode? subregionName?

    Properties

    cityCode?: string | null

    City/Locality code

    cityName?: string | null

    City/Locality name

    coord: Coordinate

    Exact coordinates of the geocoded address

    countryCode?: string | null

    Country code

    countryName?: string | null

    Country name

    formattedAddress: string

    Full formatted address (from 'desc' field)

    houseNumber?: string | null

    House number that was geocoded (from 'housenumber' field)

    municipalityCode?: string | null

    Municipality code

    municipalityName?: string | null

    Municipality name

    name?: string | null

    Short name (from 'name' field)

    postalCode?: string | null

    Postal code (from 'postalcode' field)

    regionCode?: string | null

    Region/Community code

    regionName?: string | null

    Region/Community name

    streetCode?: string | null

    Street code (from calle_id in full response)

    streetName?: string | null

    Street name

    subregionCode?: string | null

    Subregion/Province code

    subregionName?: string | null

    Subregion/Province name

    Settings

    Member Visibility

    On This Page

    Properties