利用状況 & クォータ

GenderAPI プラットフォームでは、専用のエンドポイントを通じて、アカウントの現在のクレジット残高をいつでも確認できます。 これにより、大量のオペレーションを行う際に予期しない中断を避けるため、利用状況を把握することが可能です。

✅ 残りクレジットを確認する

以下のエンドポイントを使って、現在のクォータ情報を取得できます:

GET https://api.genderapi.io/api/remaining?key=YOUR_API_KEY

curl を使ったリクエスト例:

curl "https://api.genderapi.io/api/remaining?key=YOUR_API_KEY"

✅ レスポンス例

API は JSON オブジェクトを返します:

{
  "status": true,
  "remaining": 9443,
  "expiresAt": 1752651601
}

レスポンスフィールド

フィールド 説明
status Boolean リクエストが成功したかどうかを示します。API キーが有効な場合、true が返されます。
remaining Integer アカウントに残っている API クレジットの数。
expiresAt Integer (timestamp) 現在のクレジットパッケージが期限切れになる Unix タイムスタンプ。

利用例

  • ダッシュボード UI で現在のクォータ情報を表示する。
  • クレジットが閾値を下回ったときにアラートを出す。
  • 課金やモニタリングツールと統合して、サービス停止を回避する。
重要: 残りのクレジットを常に把握し、クォータ切れによる予期しないエラーを避けてください。大量処理や自動化スクリプトは、定期的にクォータを確認することを推奨します。