Skip to main content

銀行情報API

※ 銀行情報データは「角ちゃんのページ」様にデータ提供を受け、これをベースに弊社独自の更新検知や加工を行い、APIとして提供しています。

GET /v1/bank​

日本全国の銀行と、それに対応する金融機関コードや銀行名等の一覧を取得します。

リソースURL​

https://api.kenall.jp/v1/bank

レスポンス​

以下はレスポンスの一例です。

{
    "version": "2023-08-21",
    "data": [
        {
            "code": "0001",
            "name": "みずほ",
            "katakana": "ミズホ",
            "hiragana": "みずほ",
            "romaji": "mizuho"
        },
        {
            "code": "0005",
            "name": "三菱UFJ",
            "katakana": "ミツビシユーエフジエイ",
            "hiragana": "みつびしゆーえふじえい",
            "romaji": "mitsubishiyu-efujiei"
        },
    ]
}

レスポンスのデータは以下のような構成になっています。

名前型説明例
versionstringデータのバージョン"2023-08-21"
dataarray銀行データの配列[...]

銀行データは以下のような構成になっています。

名前型説明例
codestring銀行コード"0001"
namestring銀行名"みずほ"
katakanastring銀行名のカタカナ表記"ミズホ"
hiraganastring銀行名のひらがな表記"みずほ"
romajistring銀行名のローマ字表記"mizuho"

GET /v1/bank/:銀行コード​

指定した銀行の金融機関コードや銀行名等の情報を取得します。

リソースURL​

https://api.kenall.jp/v1/bank/:銀行コード

パラメーター​

名前型必須かどうか説明例
:銀行コードstring必須銀行コード"0001"

レスポンス​

以下はレスポンスの一例です。

{
    "version": "2023-08-21",
    "data": [
        {
            "code": "0001",
            "name": "みずほ",
            "katakana": "ミズホ",
            "hiragana": "みずほ",
            "romaji": "mizuho"
        }
    ]
}

レスポンスのデータは以下のような構成になっています。

名前型説明例
versionstringデータのバージョン"2023-08-21"

銀行データは以下のような構成になっています。

名前型説明例
codestring銀行コード"0001"
namestring銀行名"みずほ"
katakanastring銀行名のカタカナ表記"ミズホ"
hiraganastring銀行名のひらがな表記"みずほ"
romajistring銀行名のローマ字表記"mizuho"

GET /v1/bank/:銀行コード/branches​

指定した銀行の金融機関コードや銀行名等の情報と、支店情報の一覧を取得します。

リソースURL​

https://api.kenall.jp/v1/bank/:銀行コード/branches

パラメーター​

名前型必須かどうか説明例
:銀行コードstring必須銀行コード"0001"

レスポンス​

以下はレスポンスの一例です。

{
    "version": "2023-08-21",
    "data": {
        "bank": {
            "code": "0001",
            "name": "みずほ",
            "katakana": "ミズホ",
            "hiragana": "みずほ",
            "romaji": "mizuho"
        },
        "branches": {
            "100": {
                "code": "100",
                "name": "本店",
                "katakana": "ホンテン",
                "hiragana": "ほんてん",
                "romaji": "honten"
            },
            "105": {
                "code": "105",
                "name": "小舟町",
                "katakana": "コブナチヨウ",
                "hiragana": "こぶなちよう",
                "romaji": "kobunachiyou"
            },
        }
    }
}

レスポンスのデータは以下のような構成になっています。

名前型説明例
versionstringデータのバージョン"2023-08-21"
dataobject銀行と支店データのオブジェクト{...}

銀行データは以下のような構成になっています。

名前型説明例
codestring銀行コード"0001"
namestring銀行名"みずほ"
katakanastring銀行名のカタカナ表記"ミズホ"
hiraganastring銀行名のひらがな表記"みずほ"
romajistring銀行名のローマ字表記"mizuho"

支店データは以下のような構成になっています。

名前型説明例
codestring支店コード"100"
namestring支店名"本店"
katakanastring支店名のカタカナ表記"ホンテン"
hiraganastring支店名のひらがな表記"ほんてん"
romajistring支店名のローマ字表記"honten"

GET /v1/bank/:銀行コード/branches/:支店コード​

指定した銀行の金融機関コードや銀行名等の情報と、指定した支店の情報を取得します。

リソースURL​

https://api.kenall.jp/v1/bank/:銀行コード/branches/:支店コード

パラメーター​

名前型必須かどうか説明例
:銀行コードstring必須銀行コード"0001"
:支店コードstring必須支店コード"188"

レスポンス​

以下はレスポンスの一例です。

{
    "version": "2023-08-21",
    "data": {
        "bank": {
            "code": "0001",
            "name": "みずほ",
            "katakana": "ミズホ",
            "hiragana": "みずほ",
            "romaji": "mizuho"
        },
        "branch": {
            "188": {
                "code": "188",
                "name": "恵比寿",
                "katakana": "エビス",
                "hiragana": "えびす",
                "romaji": "ebisu"
            },
        }
    }
}

レスポンスのデータは以下のような構成になっています。

名前型説明例
versionstringデータのバージョン"2023-08-21"
dataobject銀行と支店データのオブジェクト{...}

銀行データは以下のような構成になっています。

名前型説明例
codestring銀行コード"0001"
namestring銀行名"みずほ"
katakanastring銀行名のカタカナ表記"ミズホ"
hiraganastring銀行名のひらがな表記"みずほ"
romajistring銀行名のローマ字表記"mizuho"

支店データは以下のような構成になっています。

名前型説明例
codestring支店コード"100"
namestring支店名"本店"
katakanastring支店名のカタカナ表記"ホンテン"
hiraganastring支店名のひらがな表記"ほんてん"
romajistring支店名のローマ字表記"honten"