レスポンスのページングについて

APIのレスポンスが大容量になった場合、レスポンスにpagination_keyが設定される場合があります。pagination_keyが設定された場合、次のクエリにおいて検索条件を変更せずにpagination_keyを設定してリクエストを実行することで後続のデータを取得することが可能です。レスポンスの形式は各APIのサンプルコードを参照ください。

pagination_keyを利用したPythonのサンプルコード

import requests
import json

# 通常の検索
headers = {"x-api-key": {api key}}
r_get = requests.get("https://api.jquants.com/v2/method?query=param", headers=headers)
data = r_get.json()["data"]

# 大容量データが返却された場合の再検索
# データ量により複数ページ取得できる場合があるため、pagination_keyが含まれる限り、再検索を実施
while "pagination_key" in r_get.json():
    pagination_key = r_get.json()["pagination_key"]
    r_get = requests.get(f"https://api.jquants.com/v2/method?query=param&pagination_key={pagination_key}", headers=headers)
    data += r_get.json()["data"]

クエリに対する全ての該当データを返却するまで、pagination_keyがレスポンスメッセージに設定されます。pagination_keyがレスポンスメッセージに設定されない場合はクエリに対する全ての該当データが返却されたことを意味します。
ページングの都度、pagination_keyの値は変わります。