金融機関情報を取得する

ここでは金融機関情報を取得するためのAPIについての説明をします。

URL

`https://api.ginconnect.jp/v1/banks`

認証

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

"Authorization": "Token YOUR_API_TOKEN"

パラメーター

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

絞り込み検索について

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

?filter=code==0001;hiragana==み*ほ

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

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

パターンマッチ

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

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

レスポンス

{
    "count": 1157,
    "banks": [
        {
            "code": "0001",
            "name": "みずほ",
            "katakana": "ミズホ",
            "hiragana": "みずほ",
            "halfKatakana": "ﾐｽﾞﾎ"
        },
        {
            "code": "0005",
            "name": "三菱ＵＦＪ",
            "katakana": "ミツビシユ－エフジエイ",
            "hiragana": "みつびしゆ－えふじえい",
            "halfKatakana": "ﾐﾂﾋﾞｼﾕ－ｴﾌｼﾞｴｲ"
        },
        {
            "code": "0009",
            "name": "三井住友",
            "katakana": "ミツイスミトモ",
            "hiragana": "みついすみとも",
            "halfKatakana": "ﾐﾂｲｽﾐﾄﾓ"
        },
        {
            "code": "0010",
            "name": "りそな",
            "katakana": "リソナ",
            "hiragana": "りそな",
            "halfKatakana": "ﾘｿﾅ"
        },
        {
            "code": "0017",
            "name": "埼玉りそな",
            "katakana": "サイタマリソナ",
            "hiragana": "さいたまりそな",
            "halfKatakana": "ｻｲﾀﾏﾘｿﾅ"
        },
        {
            "code": "0033",
            "name": "ＰａｙＰａｙ",
            "katakana": "ペイペイ",
            "hiragana": "ぺいぺい",
            "halfKatakana": "ﾍﾟｲﾍﾟｲ"
        },
        {
            "code": "0034",
            "name": "セブン",
            "katakana": "セブン",
            "hiragana": "せぶん",
            "halfKatakana": "ｾﾌﾞﾝ"
        },
        {
            "code": "0035",
            "name": "ソニー",
            "katakana": "ソニ－",
            "hiragana": "そに－",
            "halfKatakana": "ｿﾆ－"
        },
        {
            "code": "0036",
            "name": "楽天",
            "katakana": "ラクテン",
            "hiragana": "らくてん",
            "halfKatakana": "ﾗｸﾃﾝ"
        },
        {
            "code": "0038",
            "name": "住信ＳＢＩネット",
            "katakana": "スミシンエスビ－アイネツト",
            "hiragana": "すみしんえすび－あいねつと",
            "halfKatakana": "ｽﾐｼﾝｴｽﾋﾞ－ｱｲﾈﾂﾄ"
        }
    ]
}

JavaScriptを使った実装例

    function onFetch() {
      const url = `https://api.ginconnect.jp/v1/banks?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