金融機関 API
REST APIサンプル
金融機関コードから銀行名を取得
$ curl -s https://bank.teraren.com/banks/0001.json | jq
{
"code": "0001",
"name": "みずほ銀行",
"kana": "ミズホ",
"hira": "みずほ",
"roma": "mizuho"
}
支店コードから支店名を取得
$ curl -s https://bank.teraren.com/banks/0001/branches/001.json | jq
{
"code": "001",
"name": "東京営業部",
"kana": "トウキヨウ",
"hira": "とうきよう",
"roma": "toukiyou"
}
金融機関名で検索
$ curl -s 'https://bank.teraren.com/banks/search.json?name=みずほ' | jq
前方一致・横断検索
q は名称・カタカナ・ひらがな・ローマ字をまとめて検索します(数字だけなら code を検索)。照合方法は match で選びます。
$ curl -s 'https://bank.teraren.com/banks/search.json?q=みず&match=prefix' | jq $ curl -s 'https://bank.teraren.com/banks/search.json?code=1&match=prefix' | jq $ curl -s 'https://bank.teraren.com/banks/0001/branches/search.json?kana=ちゅうおう' | jq
検索パラメータ
/banks/search と /banks/{bank_code}/branches/search で使えます。複数指定すると AND で絞り込みます。
q: 横断検索。名称・カタカナ・ひらがな・ローマ字(それぞれ正規化後の値を含む)のどれかに一致すれば対象。数字だけならcodeを検索name/kana/hira/roma: 元の値と正規化後の値(例: 北海道信金 → 北海道信用金庫)のどちらかに一致すれば対象code: 金融機関コード(支店検索では支店コード)match:prefix(前方一致)/partial(部分一致、既定)/exact(完全一致)。すべての項目に適用。それ以外の値は 400{"error": "..."}page/per: ページング(per の最大値は 銀行 5000 / 支店 1000)
検索語は照合の前にデータの表記(全銀表記)へそろえます。
kana: ひらがな → カタカナ、半角カナ → 全角、小書き文字 → 大きい文字(ちゅうおう → チユウオウ)、長音・ハイフン類(ー - ‐ − ー)→-、英数字 → 全角大文字hira: カタカナ → ひらがな、ほかは kana と同じroma: 英数字 → 半角小文字、長音・ハイフン類 →-name: 全角英数字 → 半角、半角カナ → 全角(幅の正規化のみ)code: 全角数字 → 半角%と_はワイルドカードではなく通常の文字として扱います