opencage-api-client
    Preparing search index...

    Interface Components

    Normalized components of the address

    interface Components {
        _category: string;
        _normalized_city?: string;
        _type: string;
        body_of_water?: string;
        borough?: string;
        city?: string;
        city_district?: string;
        continent?: string;
        country?: string;
        country_code?: string;
        county?: string;
        house_number?: string;
        "ISO_3166-1_alpha-2"?: string;
        "ISO_3166-1_alpha-3"?: string;
        "ISO_3166-2"?: string[];
        neighbourhood?: string;
        office?: string;
        political_union?: string;
        postcode?: string;
        road?: string;
        state?: string;
        state_code?: string;
        suburb?: string;
        town?: string;
        village?: string;
    }
    Index

    Properties

    _category _normalized_city? _type body_of_water? borough? city? city_district? continent? country? country_code? county? house_number? ISO_3166-1_alpha-2? ISO_3166-1_alpha-3? ISO_3166-2? neighbourhood? office? political_union? postcode? road? state? state_code? suburb? town? village?

    Properties

    _category

    _category: string

    Category of the location

    Optional_normalized_city

    _normalized_city?: string

    Normalized city name

    _type

    _type: string

    Type of the location

    Optionalbody_of_water

    body_of_water?: string

    Body of water

    borough?: string

    Borough or district within a city

    city?: string

    City name

    city_district?: string

    City district

    continent?: string

    Continent name

    country?: string

    Country name

    country_code?: string

    Two-letter country code (lowercase)

    county?: string

    County or district name

    house_number?: string

    Building or house number

    "ISO_3166-1_alpha-2"?: string

    Two-letter country code

    "ISO_3166-1_alpha-3"?: string

    Three-letter country code

    "ISO_3166-2"?: string[]

    Codes for country subdivisions

    neighbourhood?: string

    Neighborhood name

    office?: string

    Office or building name

    political_union?: string

    Political union (e.g., European Union)

    postcode?: string

    Postal code

    road?: string

    Street or road name

    state?: string

    State, province, or region name

    state_code?: string

    State or province code

    suburb?: string

    Suburb name

    town?: string

    Town name

    village?: string

    Village name

    Settings

    Member Visibility

    On This Page

    Properties