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

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

Request

GET
/v2/method
import requests

headers = {"x-api-key": "{loading}"}

r_get = requests.get(
  "https://api.jquants.com/v2/method?query=param",
  headers=headers,
)
data = r_get.json()["data"]

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の値は変わります。

Was this page helpful?