API v3 リファレンス
BankcodeJP APIでは金融機関をWebクライアントやモバイルアプリケーション、Webサーバーから検索可能なAPIを提供しています。
APIは以下の主要な機能に対応しています。
- オリジン間リソース共有 (Cross-Origin Resource Sharing, CORS)
- クエリパラメータ
callback
によるJSONP - クエリパラメータ
limit
による取得件数制御 - クエリパラメータ
cursor
による次のデータの取得、前のデータの取得 - クエリパラメータ
fields
による部分応答 - クエリパラメータ
filter
によるフィード用のクリーンでシンプルなフィルタ構文 - クエリパラメータ
sort
による結果の並び替え
ベースURL
すべてのAPIはこのURLから始まります。
https://apis.bankcode-jp.com/v3/
APIキー
APIは、APIキーを使用してリクエストを認証します。
認証はリクエストパラメータまたはリクエストヘッダに設定されたAPIキーを介して実行されます。 すべてのAPIリクエストはHTTPSを介して行われる必要があります。
APIキーの取得
以下の手順でAPIキーを取得します。
- ダッシュボードに移動します。(アカウントをお持ちでない場合は アカウントを作成してください。)
- ダッシュボードの「APIキーを作成」ボタンをクリックします。
- 作成されたAPIキーに制限を設定します。(APIキーの盗用、不正使用を防ぐため、HTTPリファラーやIPアドレスでAPIキーを保護します。)
リクエストにAPIキーを設定する
クエリパラメータの場合
# URLの apikey クエリパラメータにAPIキーを設定します。
curl https://apis.bankcode-jp.com/v3/banks \
-G -v \
-d "apikey=ここにAPIキーを設定"
リクエストヘッダの場合
# apikey ヘッダにAPIキーを設定します。
curl https://apis.bankcode-jp.com/v3/banks \
-G -v \
-H "apikey: ここにAPIキーを設定"
APIキーは、URLのクエリパラメータまたは、HTTPヘッダーのどちらかで設定することができます。
インターネットに接続されるモバイルアプリやIoTデバイス等 APIキーをIPアドレスやリファラで保護できない場合、HTTPヘッダーにAPIキーを設定してください。SSL/TLSによりAPIキーが保護されます。
リソース
金融機関リソース
APIで1つまたは複数の金融機関リソースを取得することができます。 金融機関リソースには金融機関コード、金融機関名とそのひらがな、カタカナ等が含まれます。
金融機関リソースのメタデータ
{
"code": string,
"name": string,
"halfWidthKana": string,
"fullWidthKana": string,
"hiragana": string,
"businessTypeCode": string,
"businessType": string
}
プロパティ | 値の型 | 説明 | 備考 |
---|---|---|---|
code | string | 金融機関コード | 半角数字4桁 |
name | string | 金融機関名 | |
halfWidthKana | string | 金融機関名 半角カタカナ | *1 |
fullWidthKana | string | 金融機関名 全角カタカナ | *2 |
hiragana | string | 金融機関名 ひらがな | *3 |
businessTypeCode | string | 金融機関種別コード | *4 |
businessType | string | 金融機関種別 | *4 |
*1) 半角カタカナとASCII印字可能文字のみ含まれる。
*2) 全角カタカナとASCII印字可能文字の全角文字のみ含まれる。
*3) ひらがなとASCII印字可能文字の全角文字のみ含まれる。
*4) 金融機関種別APIを使うと全ての金融機関種別を一覧することができます。
支店リソース
APIで金融機関に存在する1つまたは複数の支店リソースを取得することができます。 支店リソースには支店コード、支店名とそのひらがな、カタカナ等が含まれます。
支店リソースのメタデータ
{
"code": string,
"name": string,
"halfWidthKana": string,
"fullWidthKana": string,
"hiragana": string,
}
プロパティ | 値の型 | 説明 | 備考 |
---|---|---|---|
code | string | 支店コード | 半角数字3桁 |
name | string | 支店名 | |
halfWidthKana | string | 支店名 半角カタカナ | *1 |
fullWidthKana | string | 支店名 全角カタカナ | *2 |
hiragana | string | 支店名 ひらがな | *3 |
*1) 半角カタカナとASCII印字可能文字のみ含まれる。
*2) 全角カタカナとASCII印字可能文字の全角文字のみ含まれる。
*3) ひらがなとASCII印字可能文字の全角文字のみ含まれる。
金融機関種別リソース
APIで1つまたは複数の金融機関種別リソースを取得することができます。 金融機関種別リソースには都市銀行や地方銀行といった金融機関をグループ化した種別を示すコードと名前が含まれます。
金融機関リソースのメタデータ
{
"code": string,
"name": string
}
プロパティ | 値の型 | 説明 | 備考 |
---|---|---|---|
code | string | 金融機関種別コード | |
name | string | 金融機関種別 |
リソースの部分応答
部分応答を利用すると、APIから返されるリソースに含まれるすべての項目を取得するのではなく必要な項目のみを取得することができます。
返されるデータを選択的にすることにより、ペイロードサイズを削減できます。
リクエストのクエリパラメータfields
にレスポンスに必要な項目のプロパティ名をカンマ区切りで指定します。
fields
クエリパラメータによる部分応答リクエスト
# fields クエリパラメータに取得するプロパティ名を指定します。
curl https://apis.bankcode-jp.com/v3/banks \
-G -v \
-d "limit=1" \
-d "fields=code,name,hiragana"
レスポンスボディ
{
"banks": [
{
"code": "0001",
"name": "みずほ銀行",
"hiragana": "みずほぎんこう"
}
],
"size": 1,
"limit": 1,
"hasNext": true,
"nextCursor": "61os1dkE26NnXsq1zcNGbQ",
"hasPrev": false,
"version": "2023-05-18T00:02:15+0900"
}
フィルタ構文
クエリパラメータのfilter
を使用すると、リソースを柔軟にフィルタできます。
例えば、次のようにリソースをクエリできます。
/banks?filter=hiragana==あ*
これは 金融機関名ひらがな が あ で始まる金融機関リソースを検索します。
/banks/0001/branches?filter=(hiragana==あ*,hiragana==ま*)
これは金融機関コードが"0001"で、支店名ひらがなが"あ"または"ま"で始まる支店リソースを検索します。
フィルタ式は、論理演算子で相互に関連付けられた1つ以上の比較で構成されます。
論理演算子
- 論理AND:
;
またはand
- 論理OR:
,
またはor
AND演算子が優先されます。(OR演算子よりも先に評価されます。)
ただし、括弧( )
で囲まれた式を利用して評価の優先順位を変更できます。
比較
比較は、プロパティ名 演算子 引数
で構成されます。
プロパティ名
プロパティ名は、フィルターを適用するフィールドたとえばcode
やname
などを識別します。
演算子
- 等しい :
==
(パターンマッチングを使用できます。) - 等しくない :
!=
(パターンマッチングを使用できます。) - より小さい :
=lt=
or<
- 以下 :
=le=
or<=
- より大きい:
=gt=
or>
- 以上 :
=ge=
or>=
- 含む :
=in=
- 含まない :
=out=
- 正規表現 :
=re=
引数
引数は、単一の値、またはコンマで区切られた括弧内の複数の値です。
含む
、含まない
の引数では、一つまたは複数の引数を括弧で囲みます。
予約文字や空白を含まない値は引用符で囲むことはできません。
他の引数は一重引用符または二重引用符で囲む必要があります。
例えば引数内で括弧を利用するにはfilter=name=re="^.*(葉|田)$"
のように引用符で囲みます。
引用符で囲まれた引数内で一重引用符と二重引用符の両方を使用する必要がある場合は、\
(バックスラッシュ)を使用してそれらの一方をエスケープする必要があります。
\
を文字通りに使用したい場合は、\\
のようにエスケープして使用します。
バックスラッシュは、引用符で囲まれていない引数内ではなく、引用符で囲まれた引数内でのみ特別な意味を持ちます。
パターンマッチング
演算子の等しい
と等しくない
の引数では、パターンマッチングを使用できます。
引数の中にあるアンダースコア _
はすべての一文字との一致を意味し、アスタリスク *
は 0 文字以上の文字列との一致を意味します。
正規表現
演算子正規表現
の引数に、一般的な正規表現構文を使用できます。
APIの正規表現エンジンの構文は他の多くの正規表現エンジンの構文と同じですが、一部特徴的な違いがあります。
他の正規表現の構文との特徴的な違いは ^
と $
です。APIの正規表現の構文では ^
は行頭を表し、 $
は行末を表します。
他の多くの正規表現の構文では、 ^
はテキストの先頭を表し、 $
はテキストの最後を表します。
APIの正規表現の構文ではテキストの先頭を表す場合は \A
を使い、テキストの最後を表す場合は \z
を使います。
すべての構文は以下で説明されています。
https://github.com/k-takata/Onigmo/blob/master/doc/RE.ja
フィルタ構文の文法
input = or, EOF; or = and, { ( "," | " or " ) , and }; and = constraint, { ( ";" | " and " ), constraint }; constraint = ( group | comparison ); group = "(", or, ")"; comparison = selector, comparator, arguments; selector = unreserved-str; comparator = comp-fiql | comp-alt; comp-fiql = ( ( "=", { ALPHA } ) | "!" ), "="; comp-alt = ( ">" | "<" ), [ "=" ]; arguments = ( "(", value, { "," , value }, ")" ) | value; value = unreserved-str | double-quoted | single-quoted; unreserved-str = unreserved, { unreserved } single-quoted = "'", { ( escaped | all-chars - ( "'" | "\" ) ) }, "'"; double-quoted = '"', { ( escaped | all-chars - ( '"' | "\" ) ) }, '"'; reserved = '"' | "'" | "(" | ")" | ";" | "," | "=" | "!" | "~" | "<" | ">" | " "; unreserved = all-chars - reserved; escaped = "\", all-chars; all-chars = ? all unicode characters ?;
サンプル
サンプル | 備考 |
---|---|
code==0001 |
完全一致 |
name==あ* |
前方一致 (比較演算子) |
name=re=^あ.*$ |
前方一致 (正規表現) 単純なパターンマッチングは正規表現よりも比較演算子を使ったほうが高速です。 |
code=in=(0001,0002) |
単一プロパティの複数値指定 |
code>=0001;code<=0100 |
範囲指定 |
code==150;(name==*出張所*,hiragana==*おやま*) |
ANDとORの組み合わせ |
並び替え
並び替えを利用すると、レスポンスに含まれるリソースの出力順序を並び替えることができます。
リクエストのクエリパラメータsort
で並べ替えの順番を、項目のプロパティ名で指定します。
複数の項目で並び替える場合はプロパティ名をカンマ区切りで指定します。
プロパティ名の前に省略可能な+
または-
を付与することで、並べ替えの方向を昇順または降順にするかを指定できます。
sort
クエリパラメータによる並び替えリクエスト
# sort クエリパラメータに並べ替えするプロパティ名を指定します。
curl https://apis.bankcode-jp.com/v3/banks/ \
-G -v \
-d "filter=businessTypeCode=in=('00300)" \
-d "sort=hiragana" \
-d "limit=5"
レスポンスボディ
{
"banks": [
{
"code": "0040",
"name": "イオン銀行",
"halfWidthKana": "イオンギンコウ",
"fullWidthKana": "イオンギンコウ",
"hiragana": "いおんぎんこう",
"businessTypeCode": "00300",
"businessType": "新たな形態の銀行"
},
{
"code": "0039",
"name": "auじぶん銀行",
"halfWidthKana": "エーユージブンギンコウ",
"fullWidthKana": "エーユージブンギンコウ",
"hiragana": "えーゆーじぶんぎんこう",
"businessTypeCode": "00300",
"businessType": "新たな形態の銀行"
},
{
"code": "0038",
"name": "住信SBIネット銀行",
"halfWidthKana": "スミシンエスビーアイネツトギンコウ",
"fullWidthKana": "スミシンエスビーアイネツトギンコウ",
"hiragana": "すみしんえすびーあいねつとぎんこう",
"businessTypeCode": "00300",
"businessType": "新たな形態の銀行"
},
{
"code": "0034",
"name": "セブン銀行",
"halfWidthKana": "セブンギンコウ",
"fullWidthKana": "セブンギンコウ",
"hiragana": "せぶんぎんこう",
"businessTypeCode": "00300",
"businessType": "新たな形態の銀行"
},
{
"code": "0035",
"name": "ソニー銀行",
"halfWidthKana": "ソニーギンコウ",
"fullWidthKana": "ソニーギンコウ",
"hiragana": "そにーぎんこう",
"businessTypeCode": "00300",
"businessType": "新たな形態の銀行"
}
],
"size": 5,
"limit": 5,
"hasNext": true,
"nextCursor": "QQqwO9LiIGATQq5vVonU7LtPVaEyp42DYtHkoZyt5TM",
"hasPrev": false,
"version": "2023-04-12T07:30:13+0900"
}
金融機関API
金融機関APIは、日本の金融機関の一覧を閲覧したり、金融機関コード、金融機関名などから検索できるAPIです。 金融機関APIを利用すれば、金融機関を検索する機能をカスタムWebサイト、Webサーバやモバイルアプリケーションへシンプルに統合できます。
金融機関一覧API
GET /v3/banks
$ curl https://apis.bankcode-jp.com/v3/banks \
-G -v \
-d "limit=3"
RESPONSE
{
"banks": [
{
"code": "0000",
"name": "日本銀行",
"halfWidthKana": "ニツポンギンコウ",
"fullWidthKana": "ニツポンギンコウ",
"hiragana": "につぽんぎんこう",
"businessTypeCode": "00100",
"businessType": "日本銀行"
},
{
"code": "0001",
"name": "みずほ銀行",
"halfWidthKana": "ミズホギンコウ",
"fullWidthKana": "ミズホギンコウ",
"hiragana": "みずほぎんこう",
"businessTypeCode": "00200",
"businessType": "都市銀行"
},
{
"code": "0005",
"name": "三菱UFJ銀行",
"halfWidthKana": "ミツビシユーエフジエイギンコウ",
"fullWidthKana": "ミツビシユーエフジエイギンコウ",
"hiragana": "みつびしゆーえふじえいぎんこう",
"businessTypeCode": "00200",
"businessType": "都市銀行"
}
],
"size": 3,
"limit": 3,
"hasNext": true,
"nextCursor": "4ml__9wFLlNhhxEF3gyeqtqLj4zuS5mb4GPcBBp0qDw",
"hasPrev": false,
"version": "2023-04-12T07:30:13+0900"
}
金融機関名の完全一致や前方一致で金融機関リソースを検索します。
リクエスト
GET https://apis.bankcode-jp.com/v3/banks
クエリパラメータ
名前 | 値 | 説明 |
---|---|---|
apiKey | string | APIキーをこのクエリパラメータもしくは、HTTPリクエスト ヘッダーのどちらかに設定します。 |
filter | string | リソースを検索するフィルタ構文。 |
limit | integer | 取得する最大件数。1~2000。(デフォルト: 20) |
cursor | string | フェッチを開始する位置を示すカーソル (直前のレスポンスのnextCursorまたはprevCursorの値) |
callback | string | JSONPを利用する場合のコールバック関数名。最大1000文字。 |
fields | string | レスポンスに含める項目。リソースの部分応答を参照。 |
sort | string | リソースの並び替え順序。リソースの並び替えを参照。 |
レスポンス
レスポンスボディに金融機関リソースが出力されます。 callbackクエリパラメータを指定した場合はcallbackの引数としてリソースが出力されます。 APIを正常に実行できない場合は エラー が出力されます。
プロパティ | 値の型 | 説明 | 備考 |
---|---|---|---|
banks | array | 検索された金融機関リソース | |
size | integer | banksのサイズ | |
limit | integer | 制限された最大件数 | |
hasNext | string | 次のリソースがある場合はtrue | |
nextCursor | string | 次のリソースをフェッチするためのカーソル | |
hasPrev | string | 前のリソースがある場合はtrue | |
prevCursor | string | 前のリソースをフェッチするためのカーソル | |
version | string | リソースのバージョン |
金融機関取得API
GET /v3/banks/{code}
$ curl https://apis.bankcode-jp.com/v3/banks/0001
RESPONSE
{
"code": "0001",
"name": "みずほ銀行",
"halfWidthKana": "ミズホギンコウ",
"fullWidthKana": "ミズホギンコウ",
"hiragana": "みずほぎんこう",
"businessTypeCode": "00200",
"businessType": "都市銀行"
}
金融機関リソースを取得します。
リクエスト
GET https://apis.bankcode-jp.com/v3/banks/{code}
パスパラメータ
名前 | 値 | 説明 |
---|---|---|
code | string | 金融機関コード |
クエリパラメータ
名前 | 値 | 説明 |
---|---|---|
apiKey | string | APIキーをこのクエリパラメータもしくは、HTTPリクエスト ヘッダーのどちらかに設定します。 |
callback | string | JSONPを利用する場合のコールバック関数名。最大1000文字。 |
fields | string | レスポンスに含める項目。リソースの部分応答を参照。 |
レスポンス
レスポンスボディに金融機関リソースが出力されます。 callbackクエリパラメータを指定した場合はcallbackの引数としてリソースが出力されます。 APIを正常に実行できない場合は エラー が出力されます。
支店API
支店APIは、特定の金融機関に所属する支店を検索できるAPIです。
支店一覧API
GET /v3/banks/{bankCode}/branches
$ curl https://apis.bankcode-jp.com/v3/banks/0001/branches \
-G -v \
-d "limit=3"
RESPONSE
{
"bank": {
"code": "0001",
"name": "みずほ銀行",
"halfWidthKana": "ミズホギンコウ",
"fullWidthKana": "ミズホギンコウ",
"hiragana": "みずほぎんこう",
"businessTypeCode": "00200",
"businessType": "都市銀行"
},
"branches": [
{
"code": "001",
"name": "東京都庁公営企業出張所",
"halfWidthKana": "トウキヨウトチヨウコウエイシユツチヨウジヨ",
"fullWidthKana": "トウキヨウトチヨウコウエイシユツチヨウジヨ",
"hiragana": "とうきようとちようこうえいしゆつちようじよ"
},
{
"code": "001",
"name": "東京営業部",
"halfWidthKana": "トウキヨウエイギヨウブ",
"fullWidthKana": "トウキヨウエイギヨウブ",
"hiragana": "とうきようえいぎようぶ"
},
{
"code": "004",
"name": "丸の内中央支店",
"halfWidthKana": "マルノウチチユウオウシテン",
"fullWidthKana": "マルノウチチユウオウシテン",
"hiragana": "まるのうちちゆうおうしてん"
}
],
"size": 3,
"limit": 3,
"hasNext": true,
"nextCursor": "KwGIGvqxWGJK7ey-FiGqLhCiiJC2W9i0hTC947bNeYI",
"hasPrev": false,
"version": "2023-04-12T07:30:13+0900"
}
特定の金融機関に所属する支店リソースを検索します。
リクエスト
GET https://apis.bankcode-jp.com/v3/banks/{bankCode}/branches
パスパラメータ
名前 | 値 | 説明 |
---|---|---|
bankCode | string | 金融機関コード |
クエリパラメータ
名前 | 値 | 説明 |
---|---|---|
apiKey | string | APIキーをこのクエリパラメータもしくは、HTTPリクエスト ヘッダーのどちらかに設定します。 |
filter | string | リソースを検索するフィルタ構文。 |
limit | integer | 取得する最大件数。1~2000。(デフォルト: 20) |
cursor | string | フェッチを開始する位置を示すカーソル (直前のレスポンスのnextCursorまたはprevCursorの値) |
callback | string | JSONPを利用する場合のコールバック関数名。最大1000文字。 |
fields | string | レスポンスに含める項目。リソースの部分応答を参照。 |
sort | string | リソースの並び替え順序。リソースの並び替えを参照。 |
レスポンス
レスポンスボディに支店リソースが出力されます。 callbackクエリパラメータを指定した場合はcallbackの引数としてリソースが出力されます。 APIを正常に実行できない場合は エラー が出力されます。
プロパティ | 値の型 | 説明 | 備考 |
---|---|---|---|
bank | object | 指定された金融機関リソース | |
branches | array | 検索された支店リソース | |
size | integer | branchesのサイズ | |
limit | integer | 制限された最大件数 | |
hasNext | string | 次のリソースがある場合はtrue | |
nextCursor | string | 次のリソースをフェッチするためのカーソル | |
hasPrev | string | 前のリソースがある場合はtrue | |
prevCursor | string | 前のリソースをフェッチするためのカーソル | |
version | string | リソースのバージョン |
支店取得API
GET /v3/banks/{bankCode}/branches/{code}
$ curl https://apis.bankcode-jp.com/v3/banks/0001/branches/001
RESPONSE
{
"bank": {
"code": "0001",
"name": "みずほ銀行",
"halfWidthKana": "ミズホギンコウ",
"fullWidthKana": "ミズホギンコウ",
"hiragana": "みずほぎんこう",
"businessTypeCode": "00200",
"businessType": "都市銀行"
},
"branch": {
"code": "001",
"name": "東京営業部",
"halfWidthKana": "トウキヨウ",
"fullWidthKana": "トウキヨウ",
"hiragana": "とうきよう"
}
}
支店リソースを取得します。
リクエスト
GET https://apis.bankcode-jp.com/v3/banks/{bankCode}/branches/{code}
パスパラメータ
名前 | 値 | 説明 |
---|---|---|
bankCode | string | 金融機関コード |
code | string | 支店コード |
クエリパラメータ
名前 | 値 | 説明 |
---|---|---|
apiKey | string | APIキーをこのクエリパラメータもしくは、HTTPリクエスト ヘッダーのどちらかに設定します。 |
callback | string | JSONPを利用する場合のコールバック関数名。最大1000文字。 |
fields | string | レスポンスに含める項目。リソースの部分応答を参照。 |
レスポンス
レスポンスボディに支店リソースが出力されます。 callbackクエリパラメータを指定した場合はcallbackの引数としてリソースが出力されます。 APIを正常に実行できない場合は エラー が出力されます。
プロパティ | 値の型 | 説明 | 備考 |
---|---|---|---|
bank | object | 指定された金融機関リソース | |
branch | object | 検索された支店リソース |
曖昧検索API
曖昧検索APIは、日本の金融機関名や支店名、カタカナ、ひらがなを対象に、検索文字列の部分一致で金融機関や支店を検索できるAPIです。
- 名称等の部分一致検索
- 同じ音となる全角ひらがな、全角カタカナ、半角カタカナの文字を同一視
- 全角ひらがな、全角カタカナ、半角カタカナの小さな文字を大きな文字と同一視
- 全角ひらがな、全角カタカナ、半角カタカナで濁点や半濁点の有無を同一視
- "ヴァヴィヴヴェヴォ"を"バビブベボ"に正規化
金融機関曖昧検索API
GET /v3/banks
$ curl https://apis.bankcode-jp.com/v3/freeword/banks \
-G -v \
-d "freeword=ちゅうおう"\
-d "businessTypeCode=00700"\
-d "businessTypeCode=01100"\
-d "limit=2"
RESPONSE
{
"banks": [
{
"code": "0142",
"name": "山梨中央銀行",
"halfWidthKana": "ヤマナシチユウオウギンコウ",
"fullWidthKana": "ヤマナシチユウオウギンコウ",
"hiragana": "やまなしちゆうおうぎんこう",
"businessTypeCode": "00700",
"businessType": "地方銀行"
},
{
"code": "0538",
"name": "静岡中央銀行",
"halfWidthKana": "シズオカチユウオウギンコウ",
"fullWidthKana": "シズオカチユウオウギンコウ",
"hiragana": "しずおかちゆうおうぎんこう",
"businessTypeCode": "01100",
"businessType": "第二地方銀行"
}
],
"size": 2,
"limit": 2,
"hasNext": true,
"nextCursor": "U9vnV9hzs90djzcH7uGAlA",
"hasPrev": false,
"version": "2023-01-04T10:56:53+0900"
}
金融機関名やふりがなに対して金融機関リソースを部分一致検索します。
freeword
パラメータで、金融機関名やふりがなに対して部分一致検索- 同じ音となる全角ひらがな、全角カタカナ、半角カタカナの文字を同一視して検索
- 全角ひらがな、全角カタカナ、半角カタカナの小さな文字を大きな文字と同一視して検索
- 全角ひらがな、全角カタカナ、半角カタカナで濁点や半濁点の有無を同一視して検索
- "ヴァヴィヴヴェヴォ"を"バビブベボ"に正規化して検索
リクエスト
GET https://apis.bankcode-jp.com/v3/freeword/banks
クエリパラメータ
名前 | 値 | 説明 |
---|---|---|
apiKey | string | APIキーをこのクエリパラメータもしくは、HTTPリクエスト ヘッダーのどちらかに設定します。 |
freeword | string | 検索文字列 |
businessTypeCode | string[] | 金融機関種別コード *1 |
limit | integer | 取得する最大件数。1~2000。(デフォルト: 20) |
cursor | string | フェッチを開始する位置を示すカーソル (直前のレスポンスのnextCursorまたはprevCursorの値) |
callback | string | JSONPを利用する場合のコールバック関数名。最大1000文字。 |
fields | string | レスポンスに含める項目。リソースの部分応答を参照。 |
sort | string | リソースの並び替え順序。リソースの並び替えを参照。 |
*1) 金融機関種別APIを使うと全ての金融機関種別を一覧することができます。複数のbusinessTypeCode
パラメータを設定した場合、or
条件となります。
レスポンス
レスポンスボディに金融機関リソースが出力されます。 callbackクエリパラメータを指定した場合はcallbackの引数としてリソースが出力されます。 APIを正常に実行できない場合は エラー が出力されます。
プロパティ | 値の型 | 説明 | 備考 |
---|---|---|---|
banks | array | 検索された金融機関リソース | |
size | integer | banksのサイズ | |
limit | integer | 制限された最大件数 | |
hasNext | string | 次のリソースがある場合はtrue | |
nextCursor | string | 次のリソースをフェッチするためのカーソル | |
hasPrev | string | 前のリソースがある場合はtrue | |
prevCursor | string | 前のリソースをフェッチするためのカーソル | |
version | string | リソースのバージョン |
支店曖昧検索API
GET /v3/freeword/banks/{bankCode}/branches
$ curl https://apis.bankcode-jp.com/v3/freeword/banks/0001/branches \
-G -v \
-d "freeword=しょ"\
-d "limit=2"
RESPONSE
{
"bank": {
"code": "0001",
"name": "みずほ銀行",
"halfWidthKana": "ミズホギンコウ",
"fullWidthKana": "ミズホギンコウ",
"hiragana": "みずほぎんこう",
"businessTypeCode": "00200",
"businessType": "都市銀行"
},
"branches": [
{
"code": "113",
"name": "兜町証券営業部",
"halfWidthKana": "カブトチヨウシヨウケンエイギヨウブ",
"fullWidthKana": "カブトチヨウシヨウケンエイギヨウブ",
"hiragana": "かぶとちようしようけんえいぎようぶ"
},
{
"code": "195",
"name": "品川区役所出張所",
"halfWidthKana": "シナガワクヤクシヨシユツチヨウジヨ",
"fullWidthKana": "シナガワクヤクシヨシユツチヨウジヨ",
"hiragana": "しながわくやくしよしゆつちようじよ"
}
],
"size": 2,
"limit": 2,
"hasNext": true,
"nextCursor": "szYnS7Hb4PG45hquow_iCQ",
"hasPrev": false,
"version": "2023-01-04T14:04:53+0900"
}
特定の金融機関に所属する支店名やふりがなに対して支店リソースを部分一致検索します。
freeword
パラメータで、支店名やふりがなに対して部分一致検索- 同じ音となる全角ひらがな、全角カタカナ、半角カタカナの文字を同一視して検索
- 全角ひらがな、全角カタカナ、半角カタカナの小さな文字を大きな文字と同一視して検索
- 全角ひらがな、全角カタカナ、半角カタカナで濁点や半濁点の有無を同一視して検索
- "ヴァヴィヴヴェヴォ"を"バビブベボ"に正規化して検索
リクエスト
GET https://apis.bankcode-jp.com/v3/freeword/banks/{bankCode}/branches
パスパラメータ
名前 | 値 | 説明 |
---|---|---|
bankCode | string | 金融機関コード |
クエリパラメータ
名前 | 値 | 説明 |
---|---|---|
apiKey | string | APIキーをこのクエリパラメータもしくは、HTTPリクエスト ヘッダーのどちらかに設定します。 |
freeword | string | 検索文字列 |
limit | integer | 取得する最大件数。1~2000。(デフォルト: 20) |
cursor | string | フェッチを開始する位置を示すカーソル (直前のレスポンスのnextCursorまたはprevCursorの値) |
callback | string | JSONPを利用する場合のコールバック関数名。最大1000文字。 |
fields | string | レスポンスに含める項目。リソースの部分応答を参照。 |
sort | string | リソースの並び替え順序。リソースの並び替えを参照。 |
レスポンス
レスポンスボディに支店リソースが出力されます。 callbackクエリパラメータを指定した場合はcallbackの引数としてリソースが出力されます。 APIを正常に実行できない場合は エラー が出力されます。
プロパティ | 値の型 | 説明 | 備考 |
---|---|---|---|
bank | object | 指定された金融機関リソース | |
branches | array | 検索された支店リソース | |
size | integer | branchesのサイズ | |
limit | integer | 制限された最大件数 | |
hasNext | string | 次のリソースがある場合はtrue | |
nextCursor | string | 次のリソースをフェッチするためのカーソル | |
hasPrev | string | 前のリソースがある場合はtrue | |
prevCursor | string | 前のリソースをフェッチするためのカーソル | |
version | string | リソースのバージョン |
金融機関種別API
金融機関種別APIは、金融機関の分類の一覧を提供します。
金融機関種別一覧API
GET /v3/banksbusinessTypes
$ curl https://apis.bankcode-jp.com/v3/businessTypes \
-G -v \
-d "limit=3"
RESPONSE
{
"businessTypes": [
{
"code": "00100",
"name": "日本銀行"
},
{
"code": "00200",
"name": "都市銀行"
},
{
"code": "00300",
"name": "新たな形態の銀行"
}
],
"size": 3,
"limit": 3,
"hasNext": true,
"nextCursor": "Ft9eP-FweU--smoW4gGi_g",
"hasPrev": false
}
金融機関種別リソースを一覧します。
リクエスト
GET https://apis.bankcode-jp.com/v3/businessTypes
クエリパラメータ
名前 | 値 | 説明 |
---|---|---|
apiKey | string | APIキーをこのクエリパラメータもしくは、HTTPリクエスト ヘッダーのどちらかに設定します。 |
filter | string | リソースを検索するフィルタ構文。 |
limit | integer | 取得する最大件数。1~2000。(デフォルト: 2000) |
cursor | string | フェッチを開始する位置を示すカーソル (直前のレスポンスのnextCursorまたはprevCursorの値) |
callback | string | JSONPを利用する場合のコールバック関数名。最大1000文字。 |
fields | string | レスポンスに含める項目。リソースの部分応答を参照。 |
sort | string | リソースの並び替え順序。リソースの並び替えを参照。 |
レスポンス
レスポンスボディに金融機関種別リソースが出力されます。 callbackクエリパラメータを指定した場合はcallbackの引数としてリソースが出力されます。 APIを正常に実行できない場合は エラー が出力されます。
プロパティ | 値の型 | 説明 | 備考 |
---|---|---|---|
businessTypes | array | 検索された金融機関リソース | |
size | integer | businessTypesのサイズ | |
limit | integer | 制限された最大件数 | |
hasNext | string | 次のリソースがある場合はtrue | |
nextCursor | string | 次のリソースをフェッチするためのカーソル | |
hasPrev | string | 前のリソースがある場合はtrue | |
prevCursor | string | 前のリソースをフェッチするためのカーソル | |
version | string | リソースのバージョン |
バージョンAPI
取り扱っている金融機関データベースのバージョン情報を取得するAPIです。
バージョンリソース
バージョンリソースのメタデータ
{
"version": string
}
プロパティ | 値の型 | 説明 | 備考 |
---|---|---|---|
version | string | 金融機関データベースのバージョン |
バージョン取得
GET /v3/version
$ curl https://apis.bankcode-jp.com/v3/version \
-G -v
RESPONSE
{
"version": "2020-08-02T18:34:46+0900"
}
リクエスト
GET https://apis.bankcode-jp.com/v3/version
クエリパラメータ
名前 | 値 | 説明 |
---|---|---|
apiKey | string | APIキーをこのクエリパラメータもしくは、HTTPリクエスト ヘッダーのどちらかに設定します。 |
レスポンス
レスポンスボディにバージョンリソースが出力されます。
エラーレスポンス
BankcodeJP APIは、HTTPレスポンスコードを使ってAPIリクエストの成功または失敗を示します。2xxの範囲のコードは成功を示します。
APIを正常に実行できない場合、HTTPステータスコードが 2xx以外で レスポンスボディにはデバッグ目的でのみ利用可能なエラーリソースが出力されます。 APIによってハンドリングできない致命的なエラーが発生した場合 HTTPステータスコードは 5xxで返却されますが、エラーリソースが出力される保証はありません。
4xxの範囲のコードは不正なリクエストパラメータにより失敗したエラーであることを示しています。
5xxの範囲のコードは、BankcodeJP APIのサーバにエラーがあることを示しています。
リソース
エラーのメタデータ
{
"httpStatusCode": integer,
"code": string,
"message": string,
"validationErrors": [
{
"message": string,
"paramName": string,
"invalidValue": string
}
]
}
プロパティ | 値の型 | 説明 |
---|---|---|
httpStatusCode | integer | HTTPステータスコード |
code | string | エラーコード |
message | string | メッセージ |
validationErrors.message | string | エラーメッセージ |
validationErrors.paramName | string | エラーとなったパラメータ名 |
validationErrors.invalidValue | string | エラーとなったパラメータの値 |
HTTPステータスコード
コード | 説明 |
---|---|
400 | Bad Request -- リクエストパラメータが不正です。 |
401 | Unauthorized -- APIキーが不正です。 |
403 | Forbidden -- リクエストが許可されていません。 |
404 | Not Found -- リソースが存在しません。 |
405 | Method Not Allowed -- HTTPメソッドが不正です。 |
406 | Not Acceptable -- 受付できないリクエストです。 |
429 | Too Many Requests -- リクエストレート制限中です。 |
500 | Internal Server Error -- サーバに異常が発生しています。後でもう一度やり直してください。 |
503 | Service Unavailable -- メンテナンスのため一時的にオフラインです。後でもう一度やり直してください。 |
リリースノート
2023-10-10
API仕様変更
下記APIのレスポンスデータに金融機関リソースを追加。
- 支店一覧API
- 支店曖昧検索API
下記APIのレスポンスデータに含まれる項目名称data
をそれぞれのリソース英名の複数形へ変更。
- 金融機関一覧API
- 支店一覧API
- 金融機関曖昧検索API
- 支店曖昧検索API