ドキュメントのセクション
利用枠と制限
制限は 2 つあります。アカウントに属する月間の呼び出しの利用枠と、リクエストが持つ認証情報ごとの 1 分あたりのリクエスト数です。残りの回数を確認しても計上されません。
月間利用枠(アカウント単位)
利用枠はキーではなくアカウントに属し、すべてのキーの呼び出しが 1 つの値に計上されます。利用枠は UTC で毎月の初めにリセットされます。拒否された呼び出し(キーがない・無効、存在しない計算ツール、解析できないボディ)は費用がかからず、計上後にサービス側で失敗した呼び出しは戻されます。
| プラン | 月間の呼び出し回数 | キー | バッチエンドポイント |
|---|---|---|---|
| Free | 5 | API キー 1 個 | なし |
| Pro · 月 $9 | 100 | API キー 3 個 | なし |
| API · 月 $19 | 10,000 | API キー 5 個 | あり(1 リクエストあたり最大 50 件) |
利用枠を使い切った場合は 402 で、401 や 429 にはなりません。エラーをご覧ください。
使用状況
GET /api/py/v1/usage は、キーまたはログイン中のセッションに対して、アカウントが今月使った量と残り、超過利用の状態、各キーに記録された呼び出しを返します。この確認は計上されないので、プログラムは 1 分あたりの制限の範囲内で、残りの呼び出し回数を何度でも表示できます。
日ごとの系列
?days=N(1〜90 の整数)を付けると、レスポンスに daily が加わります。古い順に今日(UTC)の日付まで、ちょうど N 件の {date, calls} が並びます。呼び出しのない日は 0 で表示されます。各日の値は、アカウントの全キーの呼び出しから戻された分を差し引いたものです。days がない場合、レスポンスは変わりません。
| フィールド | 説明 |
|---|---|
| tierstring | アカウントのプラン:free、pro、api のいずれか。 |
| periodstring | 暦月、YYYY-MM(UTC)。 |
| resetAtstring | 利用枠がリセットされる日時:翌月の最初の時刻。 |
| allowance, used, remaininginteger | その月の利用枠、戻された分を差し引いて計上された呼び出し回数、残り。 |
| overageobject | 従量課金による超過利用:アカウントが対象か、有効か、その使用量と上限。 |
| keysarray | アカウントの各キー:keyId、label、client、active、used、lastUsedAt。 |
| rateLimitPerMinuteinteger | リクエストが持っていた認証情報に対する 1 分あたりの制限。 |
| daily{date, calls}[] | ?days=N を付けた場合のみ:直近 N 日(UTC)それぞれの呼び出し回数。 |
使用状況ヘッダー
計上対象のすべてのレスポンス(計算ツールの呼び出し、バッチ、キー付きで投入したジョブ)には、ブラウザーで読み取れるヘッダーに同じ数値が入っています:
| ヘッダー | 意味 |
|---|---|
| X-Usage-Allowance | アカウントの月間利用枠。 |
| X-Usage-Used | 今月計上された呼び出し回数(この呼び出しを含む)。 |
| X-Usage-Reset | 利用枠がリセットされる日時(ISO-8601、UTC):翌月の最初の時刻。 |
| X-Usage-Overage | 今月、従量課金の超過利用が計上された場合のみ存在:その回数。 |
1 分あたりのリクエスト数(アドレス単位)
1 分あたりの制限は、プランではなく、リクエストが持つ認証情報で決まります。超えると API は Retry-After ヘッダー付きで 429 を返します。デバイス認可のエンドポイントは、何を送っても、認証情報なしの制限が適用されます。
| リクエストが持つもの | 1 分あたりのリクエスト数 |
|---|---|
| 認証情報なし | 30 |
| ログイン中のセッション | 60 |
| API キー | 120 |
その他の制限
- 1 回のバッチに含められる計算は最大 50 件です。バッチをご覧ください。
- 呼び出し元ごとに、キュー待ちまたは実行中のシミュレーションジョブは同時に 3 件までです。シミュレーションジョブをご覧ください。