使用状況とクレジット残高

最終更新 July 20, 2026

当月のこれまでの API 使用状況と、現在のクレジット残高を読み取る。

TEXT

GET /v1/usage

有効な API キーと有効なメンバーシップが必要である。検索エンドポイントとは異なり、これは クレジットによる制限を受けない ── 残高が空のときでも、いつでも確認できる ── そして、クレジットを 消費しない。

クエリパラメータ

なし。

レスポンス

JSON

{
  "period_start": "2026-06-01T00:00:00Z",
  "requests": 1284,
  "billable_units": 1310,
  "credits": {
    "balance_cents": 4250,
    "balance": 42.50,
    "currency": "usd",
    "included_cents": 0,
    "purchased_cents": 4250,
    "estimated_requests_remaining": 2125,
    "auto_reload_enabled": true
  }
}

フィールド	型	説明
`period_start`	string (ISO 8601, UTC)	現在の暦月の使用期間の開始。
`requests`	integer	この期間にこれまで記録された API リクエスト数。
`billable_units`	integer	この期間に消費された課金単位数(ひとつのリクエストが複数の上流取得に広がるとき、1 単位を超えて課金されることがある)。
`credits.balance_cents`	integer	残っている総残高。通貨の補助単位で表す。
`credits.balance`	number	残っている総残高。主要単位で表す。
`credits.currency`	string	ISO 通貨コード(例: `USD`、`GBP`)。
`credits.included_cents`	integer	メンバーシップの月次割当からの残高。
`credits.purchased_cents`	integer	購入したクレジットからの残高。
`credits.estimated_requests_remaining`	integer	あなたの残高でまかなえる、おおよその追加リクエスト数。
`credits.auto_reload_enabled`	boolean	アカウントで自動リロードが有効かどうか。

例

cURL

curl "https://api.suede.io/v1/usage" \
  -H "Authorization: Bearer $SUEDE_API_KEY"

using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
    new("Bearer", Environment.GetEnvironmentVariable("SUEDE_API_KEY"));
var json = await http.GetStringAsync("https://api.suede.io/v1/usage");
Console.WriteLine(json);

JavaScript

const res = await fetch("https://api.suede.io/v1/usage", {
  headers: { Authorization: `Bearer ${process.env.SUEDE_API_KEY}` },
});
const usage = await res.json();
console.log(`Balance: ${usage.credits.balance} ${usage.credits.currency}`);

同じ残高は、課金対象のすべてのレスポンスで X-Credits-Balance および X-Credits-Requests-Remaining ヘッダーを通して返される ── エラーを参照のこと。