OptionalmatchHow q is matched against the names and the readings.
Defaults to "prefix".
OptionalqThe text to search the bank names and the kana readings with.
Hiragana, katakana and kanji are all accepted; the differences in small
kana, prolonged sound marks and character width are normalized away
before matching, and a trailing institution-type suffix such as "銀行"
or "信用金庫" is ignored.
When this is given, an empty result comes back as a 200 with an empty
data rather than a 404.
Example: "みずほ"
OptionaltypeThe category of the institutions to retrieve.
OptionalversionThe version of the database that the query has to be performed against.
Defaults to the latest available version.
Example: "2026-08-01"
A
BankSearcherOptionsstores a set of parameters that will be sent tosearchBanksAPI.Every property is optional; an empty query simply retrieves the whole set, in which case the API responds with a 404 when nothing is available.