@ken-all/kenall
    Preparing search index...

    Interface AddressSearcherQuery

    An AddressSearcherQuery describes a search query and its address elements.

    interface AddressSearcherQuery {
        block_lot_num: string | null;
        building: string | null;
        city: string | null;
        city_ward: string | null;
        county: string | null;
        floor_room: string | null;
        kyoto_street: string | null;
        prefecture: string | null;
        q: string | null;
        t: string | null;
        town: string | null;
    }
    Index

    Properties

    block_lot_num: string | null

    The reconstructed numerical part of the address line below the second-level administrative division.

    Example: "3-12-14"

    building: string | null

    The extracted building name in the address line below the second-level administrative devision, without the floor name.

    Example: "麹町駅前ヒルトップ"

    city: string | null

    The name of the city, not including the county or the ward.

    Example: "各務原市"

    city_ward: string | null

    The name of the ordinance-designated wards.

    Example: "千種区"

    county: string | null

    The name of the county.

    Example: "秩父郡"

    floor_room: string | null

    The extracted floor name and room number in the address line below the second-level administrative devision.

    Example: "8階801"

    kyoto_street: string | null

    The instructional phrase (通り名 in Japanese that signifies the (non-administrative) sub-area of the town, the way which describe is very specific to a district of Kyoto city.

    Examples:

    • "先斗町通蛸薬師上る"
    • "大宮通寺之内半丁下る東入"
    prefecture: string | null

    The name of the prefecture.

    Example: "東京都"

    q: string | null

    The query that the search has been performed for.

    t: string | null

    The unprocessed portions of the address string that the search has been performed for.

    town: string | null

    The name of the town.

    Example: "箱石"