各ユーザーに対して、1分間に受付可能なリクエスト数を制限します。この制限は、以下の種別ごとに適用されます。
種別
データ取得系API
GETリクエスト
データ更新系API
POST、PATCHおよびDELETEリクエスト
制限単位
APIを利用するユーザ単位で制限を行います。あるユーザーが複数のAPIキーを取得し、いずれかのAPIキーで制限を受けている時間は、そのユーザの他のAPIキーも同じ制限を受けます。
リクエスト数の上限
リクエスト数の上限は、上記の種別と契約状態によって異なります。
種別 | 有償版契約中 | 無料トライアル中 |
データ取得系API | 200回/分 | 20回/分 |
データ更新系API | 100回/分 | 10回/分 |
現在の上限はレート制限情報の取得で確認できます。APIを利用する際は、リクエスト数が現在の上限以内に収まるようにしてください。
また、今後の運用にてシステムに高い負荷がかかり、正常な応答が難しい場合には、リクエスト数の上限が下がる可能性があることをご了承ください。
レスポンス
正常終了したAPIのレスポンスに、以下のヘッダが含まれます。
キー | 内容 |
X-RateLimit-Limit | 1分間に受付可能な最大リクエスト数 |
X-RateLimit-Remaining | X-RateLimit-Resetの間までに受付可能な残りリクエスト数 |
X-RateLimit-Reset | リクエスト数の計測がリセットされるまでの時間(秒) |
なお、上限を超えたリクエストの場合、APIサーバは429(Too many requests)を返します。
レート制限への対策
レート制限に抵触しないために、以下の対策を行ってください。
- 1つのソフトウェアから、同時に複数のリクエストを送信しない。1つのリクエストに対して応答が返されてから、次のリクエストを送信する。
- 大量のリクエストを送信する必要がある場合は、リクエストの送信ごとに最低1秒の待ち時間をおく。
- 429応答が返された場合は、1分後にリクエストを再送する。どうしても待ち時間を1分よりも短くしなければならない場合は、X-RateLimit-Resetの値をもとに待ち時間の長さを調節する。