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

    Interface BankSearcherOptions

    BankSearcherOptions は "searchBanks" API に渡すことのできるオプションの集合です。

    すべての項目は省略可能で、何も指定しなければ単に全件を取得します。その場合、 該当するデータがなければ 404 が返ります。

    interface BankSearcherOptions {
        match?: v20260801.BankSearchMatchMode;
        q?: string;
        type?: v20260801.BankType;
        version?: string;
    }
    Index

    q を名称・カナ読みとどのように照合するか。

    デフォルトは "prefix" (前方一致) です。

    q?: string

    金融機関の名称およびカナ読みを検索する文字列。

    ひらがな・カタカナ・漢字のいずれでも指定でき、小書き文字・長音記号・全半角の 表記揺れは照合前に正規化されます。また、"銀行" や "信用金庫" のような 業態を表す接尾語は無視されます。

    この項目を指定した場合、該当が0件でも 404 ではなく data が空の 200 が返ります。

    例: "みずほ"

    取得する金融機関の業態。

    version?: string

    どのデータベースのバージョンに対して検索を実行するか。

    デフォルトは最新バージョンとなります。

    例: "2026-08-01"