エラーレスポンス

RIKYU Public API は RFC 9457 Problem Details 形式でエラーを返します。

フォーマット

{
  "type": "https://errors.rikyu.jp/<error-type>",
  "title": "エラータイトル",
  "status": 400,
  "detail": "詳細なエラーの説明"
}

HTTPステータスコード一覧

ステータス	説明
400 Bad Request	リクエストパラメータが不正
401 Unauthorized	API キーが未設定または無効
403 Forbidden	権限不足（write 権限が必要なエンドポイントを read キーで呼び出した等）
404 Not Found	指定したリソースが存在しない
429 Too Many Requests	レート制限に達した
500 Internal Server Error	サーバー側のエラー

エラー例

認証エラー

{
  "type": "https://errors.rikyu.jp/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Invalid or missing API key"
}

バリデーションエラー

{
  "type": "https://errors.rikyu.jp/bad-request",
  "title": "Bad Request",
  "status": 400,
  "detail": "pageSize must not exceed 200"
}

リソース未存在

{
  "type": "https://errors.rikyu.jp/not-found",
  "title": "Not Found",
  "status": 404,
  "detail": "Wallet with id 999 not found"
}