コンテンツへスキップ

金融機関 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 で絞り込みます。

検索語は照合の前にデータの表記(全銀表記)へそろえます。