残高取得

認証されたアカウントの現在の USD 残高を返します。

残高取得

GET /v1/balance

curl -X GET "https://api.zelnum.com/api/v1/balance" \
  -H "X-API-Key: YOUR_KEY_HERE"

{
  "balance": "5.230000"
}

フィールド	タイプ	説明
`balance`	string	USD 建ての利用可能残高（小数点以下 6 桁固定）。

キー情報

リクエストで使用したキーのメタデータを返します。キー本体は返さず、マスクされた接頭辞のみを返すため、認証情報を露出せずにどのキーが使われたか確認できます。

GET /v1/api-key

curl -X GET "https://api.zelnum.com/api/v1/api-key" \
  -H "X-API-Key: YOUR_KEY_HERE"

{
  "api_key_id": 12,
  "masked_key": "ck_xxxxxxxxx…****",
  "last_used": "2026-09-12T09:14:03.000000Z",
  "created_at": "2026-08-30T11:02:44.000000Z"
}

フィールド	タイプ	説明
`api_key_id`	integer	キーの識別子。サポートへの問い合わせ時に便利です。
`masked_key`	string	マスクされた接頭辞。ここでキー本体が返ることはありません。
`last_used`	string \| null	このキーで最後に認証されたリクエストの日時。
`created_at`	string	キーの作成日時。

APIリクエストはAPIキーごとに、エンドポイント群単位で制限されます：

エンドポイント	制限
`GET /v1/balance` · `GET /v1/api-key`	APIキーあたり 60 リクエスト / 分（IP あたり 120 / 分）

エラー

ステータス	`code`	原因
`401`	`unauthorized`	APIキーが未指定、無効、または無効化されています。
`403`	`account_banned`	アカウントは停止中です。サポートにご連絡ください。
`429`	—	レート制限に達しました — レート制限を参照してください。

両エンドポイントは共通バケットを共有します: API キーあたり 60 リクエスト / 分。