支店情報を取得する

URL

`https://api.ginconnect.jp/v1/banks/{照会先金融機関コード}/branches`

認証

HTTPヘッダにAPIキーを渡してください。

"Authorization": "Token YOUR_API_TOKEN"

パラメーター

名前	型	デフォルト	必須	説明
`limit`	number	10	省略可	最大の取得件数を指定します。最大で2000件取得することが可能です。
`page`	number	1	省略可	取得するページ番号を指定します。
`filter`	string		省略可	絞り込み条件を設定します。

絞り込み検索について

支店コードや名前に基づくフィルタリングを行います。複数の条件をコロン (;) で区切って指定できます。

?filter=code==0001;katakana==トウ*

対応しているフィルタは以下の通りです

文字	意味
`code`	支店コード
`name`	支店名
`hiragana`	支店名（ひらがな）
`katakana`	支店名（カタカナ）
`half_katakana`	支店名（半角カタカナ）

パターンマッチ

ワイルドカードをつかって柔軟に検索することも可能です。

文字	意味
`*`	0文字以上の任意の文字列
`_`	1文字の任意の文字列

レスポンス

{
    "count": 494,
    "bank": {
        "code": "0001",
        "name": "みずほ",
        "katakana": "ミズホ",
        "hiragana": "みずほ",
        "halfKatakana": "ﾐｽﾞﾎ"
    },
    "branches": [
        {
            "code": "001",
            "name": "東京営業部",
            "katakana": "トウキヨウ",
            "hiragana": "とうきよう",
            "halfKatakana": "ﾄｳｷﾖｳ"
        },
        {
            "code": "004",
            "name": "丸の内中央",
            "katakana": "マルノウチチユウオウ",
            "hiragana": "まるのうちちゆうおう",
            "halfKatakana": "ﾏﾙﾉｳﾁﾁﾕｳｵｳ"
        },
        {
            "code": "005",
            "name": "丸之内",
            "katakana": "マルノウチ",
            "hiragana": "まるのうち",
            "halfKatakana": "ﾏﾙﾉｳﾁ"
        },
        {
            "code": "009",
            "name": "神田駅前",
            "katakana": "カンダエキマエ",
            "hiragana": "かんだえきまえ",
            "halfKatakana": "ｶﾝﾀﾞｴｷﾏｴ"
        },
        {
            "code": "013",
            "name": "町村会館出張所",
            "katakana": "チヨウソンカイカン",
            "hiragana": "ちようそんかいかん",
            "halfKatakana": "ﾁﾖｳｿﾝｶｲｶﾝ"
        },
        {
            "code": "015",
            "name": "築地",
            "katakana": "ツキヂ",
            "hiragana": "つきぢ",
            "halfKatakana": "ﾂｷﾁﾞ"
        },
        {
            "code": "019",
            "name": "確定拠出年金",
            "katakana": "カクテイキヨシユツネンキン",
            "hiragana": "かくていきよしゆつねんきん",
            "halfKatakana": "ｶｸﾃｲｷﾖｼﾕﾂﾈﾝｷﾝ"
        },
        {
            "code": "020",
            "name": "押上",
            "katakana": "オシアゲ",
            "hiragana": "おしあげ",
            "halfKatakana": "ｵｼｱｹﾞ"
        },
        {
            "code": "021",
            "name": "麹町",
            "katakana": "コウジマチ",
            "hiragana": "こうじまち",
            "halfKatakana": "ｺｳｼﾞﾏﾁ"
        },
        {
            "code": "022",
            "name": "浅草橋",
            "katakana": "アサクサバシ",
            "hiragana": "あさくさばし",
            "halfKatakana": "ｱｻｸｻﾊﾞｼ"
        }
    ]
}

JavaScriptを使った実装例

    function onFetch() {
      const url = `https://api.ginconnect.jp/v1/bank/0001/branches?hiragana=あ*`
      const apiToken = 'your api token'
      const headers = new Headers();
      headers.set('Content-Type', 'application/json');
        headers.set('Authorization', `Token ${apiToken}`);
      fetch(url, {
        method: 'GET',
        headers: headers
      }).then(response => response.json())
        .then(data => {
          console.log(data)
        }).catch(error => {
        console.log(error)
      })
    }

金融機関情報API Excel、Google Spreadsheet向けAPI