Change History API
Change History API
BankcodeJP APIで提供する金融機関・支店データの変更履歴を取得できるAPIです。
概要
Change History APIは、BankcodeJP APIで提供している金融機関・支店データについて、いつ・どの項目に変更があったかを確認するためのAPIです。
銀行・支店の新設、廃止、名称変更、コード変更などを確認できます。
現在、Change History APIでは2026年2月25日以降の変更履歴を参照できます。これより前の変更履歴は提供対象外です。参照可能な期間は、今後変更される場合があります。
最新データの反映タイミングにより、実際のデータ更新からAPIで確認できるまでに時間差が生じる場合があります。
利用条件
- BankcodeJP APIのAPIキーが必要です。
- すべてのプランで利用できます。
- Change History APIには専用の利用上限があります。
- 上限は 2 requests/second、5,000 requests/day です。
- この上限はSearch APIの利用上限とは別に適用されます。
レート制限ヘッダーの見方は認証・制限・エラーを参照してください。
エンドポイント
| Method | Path | 説明 |
|---|---|---|
| GET | /history/v1/updates | データ更新履歴一覧 |
| GET | /history/v1/updates/latest | 最新のデータ更新情報 |
| GET | /history/v1/changes | 変更履歴一覧 |
| GET | /history/v1/changes/{change_id} | 変更履歴詳細 |
リクエスト例
最新のデータ更新情報を取得する
curl -sS "https://apis.bankcode-jp.com/history/v1/updates/latest" \
-H "x-api-key: YOUR_API_KEY" | jqデータ更新履歴を取得する
curl -sS "https://apis.bankcode-jp.com/history/v1/updates?from_date=2026-07-01&limit=10" \
-H "x-api-key: YOUR_API_KEY" | jq変更履歴を取得する
curl -sS "https://apis.bankcode-jp.com/history/v1/changes?limit=10" \
-H "x-api-key: YOUR_API_KEY" | jq銀行コードで絞り込む
curl -sS "https://apis.bankcode-jp.com/history/v1/changes?bank_code=0140&limit=10" \
-H "x-api-key: YOUR_API_KEY" | jq変更履歴詳細を取得する
curl -sS "https://apis.bankcode-jp.com/history/v1/changes/CHANGE_ID" \
-H "x-api-key: YOUR_API_KEY" | jqAPIキーはx-api-keyヘッダーでの指定を推奨します。
リクエストパラメータ
GET /history/v1/updates
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
from_date | 任意 | string(date) | この日付以降のデータ更新履歴を取得します。形式は YYYY-MM-DD。 |
to_date | 任意 | string(date) | この日付以前のデータ更新履歴を取得します。形式は YYYY-MM-DD。 |
limit | 任意 | integer | 取得件数。省略時は100、最大1000。 |
cursor | 任意 | string | 次ページ取得用カーソル。next_cursorが返った場合に指定します。 |
GET /history/v1/updates/latest
クエリパラメータはありません。最新データセットの作成日時は、レスポンスのupdate.created_atで確認できます。created_atは、BankcodeJPの履歴データセットとして作成・登録された日時です。データの基準日はeffective_dateを参照してください。
GET /history/v1/changes
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
from_date | 任意 | string(date) | この日付以降の変更履歴を取得します。形式は YYYY-MM-DD。 |
to_date | 任意 | string(date) | この日付以前の変更履歴を取得します。形式は YYYY-MM-DD。 |
after_update_id | 任意 | string | 指定した更新IDより後の変更履歴を取得します。 |
bank_code | 任意 | string | 銀行コードで絞り込みます。例: 0140。 |
branch_code | 任意 | string | 支店コードで絞り込みます。例: 331。 |
resource_type | 任意 | string | 対象種別。bankまたはbranch。 |
change_type | 任意 | string | 変更種別。added, removed, renamed, code_changed, updated。 |
limit | 任意 | integer | 取得件数。省略時は100、最大1000。 |
cursor | 任意 | string | 次ページ取得用カーソル。next_cursorが返った場合に指定します。 |
GET /history/v1/changes/{change_id}
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
change_id | 必須 | string | 変更履歴ID。変更履歴一覧のchange_idを指定します。 |
ページング
一覧レスポンスにnext_cursorが含まれる場合、同じ検索条件でcursorに指定すると次ページを取得できます。
cursorは検索条件と紐づいています。異なる条件で使用した場合は400エラーになります。
change_type
| 値 | 説明 |
|---|---|
added | 新設 |
removed | 廃止 |
renamed | 名称変更 |
code_changed | コード変更 |
updated | その他変更 |
レスポンス項目
データ更新情報
GET /history/v1/updatesのルート項目はupdatesとnext_cursor、GET /history/v1/updates/latestのルート項目はupdateです。
| 項目 | 型 | 説明 |
|---|---|---|
updates | array<object> | データ更新履歴一覧。GET /history/v1/updatesで返ります。 |
update | object | 最新のデータ更新情報。GET /history/v1/updates/latestで返ります。 |
next_cursor | string|null | 次ページがある場合に返るカーソル。 |
update object
| 項目 | 型 | 説明 |
|---|---|---|
update_id | string | データ更新を識別するID。 |
previous_update_id | string|null | 直前のデータ更新ID。最初のデータ更新など、比較元がない場合は null。 |
effective_date | string(date) | データの基準日。JST基準の YYYY-MM-DD。 |
created_at | string(date-time) | 履歴データセットが作成・登録された日時。最新データセット作成日時はGET /history/v1/updates/latestのこの項目で確認できます。JST +09:00 のISO 8601形式。 |
run_type | string | 更新処理の種別。 |
validation_result | string | データ検証結果。 |
bank_rows | integer | 更新後の金融機関件数。 |
branch_rows | integer | 更新後の支店件数。 |
変更履歴情報
GET /history/v1/changesのルート項目はchangesとnext_cursor、GET /history/v1/changes/{change_id}のルート項目はchangeです。
| 項目 | 型 | 説明 |
|---|---|---|
changes | array<object> | 変更履歴一覧。GET /history/v1/changesで返ります。 |
change | object | 変更履歴詳細。GET /history/v1/changes/{change_id}で返ります。 |
next_cursor | string|null | 次ページがある場合に返るカーソル。 |
以下のchange objectは、GET /history/v1/changesのchanges配列要素、およびGET /history/v1/changes/{change_id}のchange内部objectです。
change object
| 項目 | 型 | 説明 |
|---|---|---|
change_id | string | 変更履歴を識別するID。 |
update_id | string | この変更が含まれるデータ更新ID。 |
previous_update_id | string|null | 直前のデータ更新ID。最初のデータ更新など、比較元がない場合は null。 |
effective_date | string(date) | 変更が含まれるデータ更新日。JST基準の YYYY-MM-DD。 |
created_at | string(date-time) | データ更新が作成された日時。JST +09:00 のISO 8601形式。 |
resource_type | string | 対象種別。bankまたはbranch。 |
change_type | string | 変更種別。added, removed, renamed, code_changed, updated。 |
reason.label_ja | string | 変更理由の日本語表示。 |
bank.code | string | 銀行コード。 |
bank.name | string|null | 銀行名。 |
branch.code | string|null | 支店コード。 |
branch.name | string|null | 支店名。 |
before | object|null | 変更前の主な項目。新設の場合など、変更前の値がない場合は空オブジェクトになることがあります。 |
after | object|null | 変更後の主な項目。廃止の場合など、変更後の値がない場合は空オブジェクトになることがあります。 |
changed_fields | array<string> | 変更判定された項目名の一覧。 |
field_changes | array<object> | 主な項目別の変更内容。変更種別や項目により、changed_fields に含まれるすべての項目が field_changes に含まれるとは限りません。 |
field_changes object
| 項目 | 型 | 説明 |
|---|---|---|
field | string | 変更された項目名。 |
before | string|number|integer|boolean|null | 変更前の値。新設など変更前の値がない場合は null。 |
after | string|number|integer|boolean|null | 変更後の値。廃止など変更後の値がない場合は null。 |
OpenAPI
機械可読なschema、コード生成用の定義はOpenAPIを参照してください。
OpenAPIで確認するエラー
| Status | 説明 |
|---|---|
| 400 | クエリパラメータ不正、カーソル不正 |
| 401 | APIキー未指定または認証失敗 |
| 403 | 利用権限なし |
| 404 | 指定したデータ更新または変更履歴が存在しない |
| 429 | Change History API専用の利用上限超過 |
| 5xx | 一時的なサーバーエラー |
注意
- Change History APIは、BankcodeJP APIで提供している金融機関・支店データについて、いつ・どの項目に変更があったかを確認するためのAPIです。
- データの利用範囲はBankcodeJP API利用規約に従ってください。
- 大量アクセスや定期取得を行う場合は、レート制限に注意してください。