スタートガイド

アカウント作成からAPI呼び出しまでの手順。

1. アカウント登録

1. 新規登録ページ にアクセスする
2. メールアドレスとパスワード（6文字以上）を設定する
3. 「アカウントを作成する」をクリック後に届く確認メールで認証を完了する

注記: 新規登録は現在一時停止しています。再開まで今しばらくお待ちください。

2. APIキーの取得

1. ログイン後のダッシュボードで「APIキーの新規登録」をクリックする
2. 以下を設定して発行する

発行時に一度だけ表示されるAPIキー（gk_ で始まる文字列）をコピーして安全に保管する。キーは再表示できない。

3. APIを呼び出す

curl（ターミナル）

curl -H "Authorization: Bearer $YOUR_API_KEY" "https://api.ginconnect.jp/v1/banks"

レスポンス例

{
  "success": true,
  "data": {
    "banks": [
      {
        "code": "0001",
        "name": "みずほ",
        "katakana": "ミズホ",
        "hiragana": "みずほ",
        "halfKatakana": "ﾐｽﾞﾎ"
      }
    ],
    "count": 1,
    "pagination": { "page": 1, "limit": 100, "total": 1157, "hasMore": true }
  },
  "metadata": { "timestamp": "2026-07-17T00:00:00.000Z" }
}

JavaScript（ブラウザ）

<script>
  function onFetch() {
    fetch("https://api.ginconnect.jp/v1/banks", {
      method: "GET",
      headers: { Authorization: "Bearer <<your token>>" },
    })
      .then((response) => response.json())
      .then((data) => console.log(data))
      .catch((error) => console.log(error));
  }
</script>
<button onclick="onFetch()">Fetch</button>

ブラウザから利用する場合、APIキーがページの閲覧者に見えてしまう点に注意。公開サイトへの埋め込みは避け、サーバー側から呼び出すことを推奨。

4. フィルタを使った絞り込み

filter パラメータに フィールド:値 形式で条件を指定する。複数条件はカンマ区切り。

GET /v1/banks?filter=hiragana:み*

「み」で始まる金融機関を取得する。対応フィールドやワイルドカードの詳細は公開API仕様を参照。

5. 重要な注意事項

• 取得件数: 1リクエストの上限は100件（limit のデフォルトも100）。全件取得には page によるページネーションを利用する
• フィルタ条件: ワイルドカードを含まない値は完全一致。条件の指定誤りはエラーにならず、単に絞り込まれない・0件になるので注意
• トークン管理: APIキーは第三者に知られると不正利用される恐れがある。取り扱いはAPIキーについてを参照

関連ドキュメント

• APIキーについて
• 公開API仕様