日本の金融機関コード・支店コードを返す REST API です。GET のみ・JSON 固定・CORS 対応。
https://zengin.tkn.jp/v3
HTTPS のみ。GET 以外のメソッドは 405 METHOD_NOT_ALLOWED を返します。
APIキーを apikey ヘッダー、または ?apikey= クエリパラメータで送信します。
# ヘッダー (推奨)
curl -H "apikey: YOUR_API_KEY" \
https://zengin.tkn.jp/v3/banks/0001
# クエリパラメータ
curl "https://zengin.tkn.jp/v3/banks/0001?apikey=YOUR_API_KEY"
キーはデベロッパーコンソールで発行・失効できます。
失効済みキーを使うと 401 UNAUTHORIZED(API key has been revoked.)になります。
一覧・検索系は data 配列とページング情報を返します。
{
"data": [ /* 銀行または支店オブジェクト */ ],
"size": 2, // このレスポンスの件数
"limit": 100, // 要求された limit
"hasNext": true, // 次ページの有無
"total": 1152 // 条件に一致する総件数
}
単一リソース系(/banks/{code} など)はオブジェクトを直接返します。
{
"code": "0009",
"fullname": "三井住友銀行",
"name": "三井住友",
"kana": "ミツイスミトモ",
"hira": "みついすみとも",
"roma": "mitsuisumitomo",
"biz_type": "1",
"biz_name": "銀行",
"biz_kana": "ギンコウ"
}
/v3/banks — 銀行一覧| パラメータ | 説明 |
|---|---|
limit | 取得件数。1〜2000(既定 100) |
offset | 開始位置(既定 0) |
biz_type | 金融機関区分で絞り込み(下記マスタの code) |
curl -H "apikey: YOUR_API_KEY" \
"https://zengin.tkn.jp/v3/banks?biz_type=2&limit=50"
/v3/banks/{bankCode} — 銀行詳細bankCode は4桁の金融機関コード。存在しない場合 404 NOT_FOUND。
curl -H "apikey: YOUR_API_KEY" https://zengin.tkn.jp/v3/banks/0009
/v3/freeword/banks — 銀行フリーワード検索| パラメータ | 説明 |
|---|---|
q | 検索語。漢字・カナ・ひらがな・ローマ字・正式名称に部分一致(空なら全件) |
limit / offset | 上記と同じ |
biz_type | 区分での絞り込み(併用可) |
「みずほ」「ミズホ」「mizuho」「三井住友銀行」いずれでもヒットします。
curl -H "apikey: YOUR_API_KEY" \
"https://zengin.tkn.jp/v3/freeword/banks?q=みずほ"
/v3/banks/{bankCode}/branches — 支店一覧limit / offset が使えます。
curl -H "apikey: YOUR_API_KEY" \
"https://zengin.tkn.jp/v3/banks/0009/branches?limit=100"
/v3/banks/{bankCode}/branches/{branchCode} — 支店詳細branchCode は3桁(一部4桁)の支店コード。
curl -H "apikey: YOUR_API_KEY" https://zengin.tkn.jp/v3/banks/0009/branches/001
/v3/freeword/banks/{bankCode}/branches — 支店フリーワード検索curl -H "apikey: YOUR_API_KEY" \
"https://zengin.tkn.jp/v3/freeword/banks/0009/branches?q=本店"
/v3/businessTypes — 金融機関区分一覧区分コードと名称・登録件数を返します(下表と同じ内容)。
/v3/version — データバージョン元データの更新日・収録件数を返します。
銀行オブジェクト
| フィールド | 例 | 説明 |
|---|---|---|
code | 0009 | 4桁の金融機関コード |
fullname | 三井住友銀行 | 正式名称。name に区分の末尾を補ったもの |
name | 三井住友 | 全銀データ上の名称(「銀行」「信用金庫」等を含まない) |
kana | ミツイスミトモ | 半角カナ由来の全角カナ表記 |
hira | みついすみとも | ひらがな表記 |
roma | mitsuisumitomo | ローマ字表記 |
biz_type | 1 | 金融機関区分コード |
biz_name | 銀行 | 金融機関区分の名称 |
biz_kana | ギンコウ | 金融機関区分のカナ |
支店オブジェクト
| フィールド | 例 | 説明 |
|---|---|---|
code | 001 | 支店コード(3桁、一部4桁) |
name | 本店営業部 | 支店名 |
kana / hira / roma | ホンテン | 各表記 |
全銀データの name には業態の末尾が含まれないため、コード帯と名称から区分を判定して付与しています。
biz_type は絞り込みパラメータにもそのまま使えます。
| code | 区分 | カナ | 登録件数 |
|---|---|---|---|
1 |
銀行 | ギンコウ | 181 |
2 |
信用金庫 | シンヨウキンコ | 254 |
3 |
信用組合 | シンヨウクミアイ | 143 |
4 |
農業協同組合 | ノウギョウキョウドウクミアイ | 509 |
5 |
漁業協同組合 | ギョギョウキョウドウクミアイ | 3 |
6 |
労働金庫 | ロウドウキンコ | 13 |
7 |
ゆうちょ銀行 | ユウチョギンコウ | 1 |
8 |
信用農業協同組合連合会 | シンヨウノウギョウキョウドウクミアイレンゴウカイ | 31 |
9 |
信用漁業協同組合連合会 | シンヨウギョギョウキョウドウクミアイレンゴウカイ | 10 |
10 |
系統中央機関 | ケイトウチュウオウキカン | 5 |
99 |
その他 | ソノタ | 2 |
APIキー単位の日次上限です(JST 0時リセット)。
| プラン | 月額 | 日次上限 |
|---|---|---|
| Free | 無料 | 350 req/day |
| Standard | ¥1,000/月 | 3,400 req/day |
| Pro | ¥5,000/月 | 無制限 |
全レスポンスに残量ヘッダーが付きます。
x-ratelimit-limit-day: 350
x-ratelimit-remaining-day: 342
x-ratelimit-reset-day: 1754924400
{
"httpStatusCode": 404,
"code": "NOT_FOUND",
"message": "Bank '9999' not found."
}
| HTTP | code | 発生条件 |
|---|---|---|
| 400 | INVALID_PARAMETER | biz_type に未定義の区分コードを指定した |
| 401 | UNAUTHORIZED | APIキー未指定・不正・失効済み |
| 404 | NOT_FOUND | 該当する銀行・支店が無い/存在しないパス |
| 405 | METHOD_NOT_ALLOWED | GET 以外のメソッド |
| 429 | RATE_LIMIT_EXCEEDED | 日次上限を超過(JST 0時にリセット) |
元データは zengin-code/source-data です。
更新に追随して定期的に取り込んでいます。
現在の収録内容は 20260824 版、
銀行 1,152 件 / 支店 29,052 件です。
fullname と biz_type は元データには無く、本サービスで付与している独自フィールドです。