すべてのドキュメントを閲覧

エラーとクォータ

HTTP ステータスと安定した機械可読コードで Narwhal の問題を処理します。

REST エラーが使用するもの: application/problem+json。MCPツールのエラーは、構造化コンテンツ内で同じ問題フィールドを持ちます。

問題レスポンス

次の条件分岐 status 最初と code 秒。次のように扱います: detail 安定したプログラム値ではなく、人が読める診断テキストとして。

RFC 9457 問題
{
  "ok": false,
  "type": "https://narwhalapi.com/problems/series-not-found",
  "title": "Economics series not found",
  "status": 404,
  "detail": "No approved economics observations matched the request.",
  "code": "series_not_found",
  "request_id": "019d1af4-8f33-7b21-91af-ef535f2dcf50",
  "instance": "/v1/economics/USA/cpi"
}

ステータスとコード

ステータス公開コード意味
400invalid_query国、期間、その他のリクエスト入力が無効です。
401invalid_api_keyBearer キーがない、形式不正、未知、または無効です。
404series_not_foundリクエストに一致する承認済みの最新または過去の観測値はありません。
404route_not_found指定された REST ルートは存在しません。
404tool_not_found指定された MCP ツールは公開されていないか、存在しません。
405method_not_allowedルートは存在しますが、指定された HTTP メソッドを受け付けません。
429rate_limit_exceededネットワークまたはアカウントの短時間上限に達しました。再試行時刻: Retry-After.
429quota_exhaustedアカウントが月間リクエスト枠を使い切りました。
500internal_errorNarwhalはリクエストを完了できませんでした。
503api_disabled公開データゲートは一時的に閉鎖されています。
503economics_unavailableNarwhalは受け入れ済み公式公開内容からリクエストを安全に満たせません。
503database_unavailableデータストアは一時的に利用できません。
503rights_state_changingNarwhalは、レスポンスの準備中にソース権限が変更されていないことを確認できませんでした。

クォータヘッダー

成功したデータレスポンスはクォータを正確に1回消費し、次を含みます:

X-Request-IDX-RateLimit-LimitX-RateLimit-RemainingX-RateLimit-ResetX-RateLimit-Short-LimitX-RateLimit-Short-RemainingX-RateLimit-Short-Reset

通常のヘッダーが示すもの: 3,000-リクエストのUTC月間許容量。認証済みレスポンスでは、短時間ウィンドウのヘッダーに無料アカウントの上限が示されます。 30 1分あたりのリクエスト数。バースト上限: 5。別の不正利用防止バケットにより、1つのネットワーク識別子につき毎分120リクエスト、バースト20が許可されます。そのため、同じアドレスを共有するクライアントはまとめてスロットリングされる場合があります。 429 rate_limit_exceeded 含むもの: Retry-After 制限対象の短時間枠向け: 429 quota_exhausted 次の UTC 暦月を待ちます。どちらのレスポンスも月間クォータを消費しません。

再試行の動作

  • 再試行しないでください 400 リクエストが修正されるまで。
  • 再試行しないでください 401 同じ拒否されたキーを使用します。
  • 再試行 429 次の後に限る: Retry-After または X-RateLimit-Reset.
  • 冪等なリクエストの再試行まで: 500 または 503 上限付き指数バックオフとジッターを使用します。
  • A 404 series_not_found サポート対象の公式リリースが公開された後にのみ利用可能になる場合があります。

ヘルプを求める

エンドポイント、UTC 時刻、ステータス、コード、次を送信: request_id 宛先: Narwhal APIサポート。APIキーは絶対に含めないでください。

戻る: クイックスタート または次を確認: Economics APIリファレンス.