レスポンスステータス
J-Quants API へのリクエスト結果は、HTTP ステータスコードで示されます。
処理に成功した場合は 200 が返され、エラーが発生した場合は 400 番台または 500 番台のエラーコードが返されます。
エラーレスポンスの Body には、エラーの詳細を示す JSON オブジェクトが含まれる場合があります。
ステータスコード一覧
| ステータスコード | 名称 | 説明 |
|---|---|---|
| 200 | OK | リクエストは成功しました。 |
| 210 | No Content (Partial) | 取得可能時間外または存在しない銘柄コード等の理由で、データが取得できませんでした(前場四本値 API など一部の API で使用されます)。 |
| 400 | Bad Request | リクエストパラメータが不正、または必須パラメータが欠如しています。 |
| 403 | Forbidden | アクセス権限がありません。原因によってメッセージが返却されるため、詳細は403 Forbidden の原因と対処をご参照ください。 |
| 429 | Too Many Requests | リクエスト回数が制限(レートリミット)を超過しました。Retry-After ヘッダーは付与していないため、直ちに再試行せず、1分以上(確実を期す場合は2分程度)待機してからリクエストを再開してください。詳細はレートリミットについてをご参照ください。 |
| 500 | Internal Server Error | サーバー内部でエラーが発生しました。時間を置いて再試行してください。 |
403 Forbidden の原因と対処
403 は複数の原因で返却され、原因によってレスポンスのメッセージが異なります。
The incoming api key is invalid or expired.— APIキーの値が有効なキーとして認識できない場合に返却されます。対処はFAQ「403エラーで「invalid or expired」というメッセージが返されます。」をご参照ください。- 契約プランに含まれていないデータ・エンドポイントへのアクセス — ご契約プランで利用可能なAPIとデータ格納期間は契約ごとに利用可能なAPIとデータ格納期間をご参照ください。
- URL・HTTPメソッドの誤り — リクエストの形式はクイックスタートでご確認ください。V1のエンドポイントをご利用の場合はV1からV2への移行もあわせてご参照ください。
該当データが0件の場合
検索条件に該当するデータが存在しない場合もエラーにはならず、ステータスコード 200 で data に空配列が設定されたレスポンスが返却されます。この場合、pagination_key は付与されません。
{
"data": []
}
エラーメッセージの例
エラー時には以下のような JSON 形式で詳細が返却されます。なお、エラー時のレスポンスボディに message が含まれる場合がありますが、常に含まれることは保証しておりません。
{
"message": "This API requires at least 1 parameter as follows; date, code"
}