Skip to main content

jquants_api/
lib.rs

1//! J-Quants API v2 の非公式 Rust クライアント。
2//!
3//! Unofficial async Rust client for the [J-Quants API](https://jpx-jquants.com/) v2 —
4//! Japanese stock market data (equities, financials, margin trading, short selling,
5//! derivatives, indices, timely disclosure) by JPX Market Innovation & Research.
6//!
7//! J-Quants API は JPX 総研が提供する個人投資家向けの日本株データ API。
8//! 本クレートの利用には J-Quants の契約(API キー、無料プランあり)が必要で、
9//! 取得したデータの扱いは J-Quants の利用規約に従うこと。
10//!
11//! # クイックスタート
12//!
13//! API キーを <https://jpx-jquants.com/dashboard/api-keys> で発行し、
14//! 環境変数 `JQUANTS_API_KEY` に設定する。
15//!
16//! ```no_run
17//! use jquants_api::{CodeDateQuery, JQuantsClient};
18//!
19//! # async fn run() -> Result<(), jquants_api::Error> {
20//! let client = JQuantsClient::from_env()?; // JQUANTS_API_KEY を読む
21//!
22//! let query = CodeDateQuery {
23//!     code: Some("7203".into()),
24//!     from: Some("2026-01-01".into()),
25//!     ..Default::default()
26//! };
27//! let bars = client.daily_bars(&query).await?;
28//! for bar in &bars {
29//!     println!("{} close={:?} (adjusted: {:?})", bar.date, bar.close, bar.adj_close);
30//! }
31//! # Ok(())
32//! # }
33//! ```
34//!
35//! # 設計
36//!
37//! - ページ分割(`pagination_key`)は各メソッドが自動追従し、全件を結合して返す
38//! - [`fins_summary`](JQuantsClient::fins_summary) / [`fins_details`](JQuantsClient::fins_details) /
39//!   [`td_list`](JQuantsClient::td_list) は [`CursorPage`] を返す。`cursor` を保存して
40//!   次回のクエリに渡すと、前回以降の差分だけ取得できる
41//! - string / number / null が混在する項目は [`FlexString`] で受け取る([`FlexString::as_f64`] あり)
42//! - [`JQuantsClient::with_plan`] / [`JQuantsClient::with_rate_limit`] で、契約プランの
43//!   API コール制限(Free 5 件/分〜Premium 500 件/分)に合わせた自動待機を有効にできる
44//!   (既定は無効)。それでも `Error::Api { status: 429, .. }` が返ったら間隔を空けること
45//!
46//! ```no_run
47//! use jquants_api::{FinsQuery, JQuantsClient};
48//!
49//! # async fn run(client: &JQuantsClient, saved: Option<String>) -> Result<(), jquants_api::Error> {
50//! // 差分取得: 前回保存した cursor を渡す
51//! let page = client
52//!     .fins_summary(&FinsQuery { cursor: saved, ..Default::default() })
53//!     .await?;
54//! for row in &page.items {
55//!     println!("{} {} sales={}", row.disc_date, row.code, row.sales);
56//! }
57//! let next_cursor = page.cursor; // 保存して次回に渡す
58//! # Ok(())
59//! # }
60//! ```
61
62#![warn(missing_docs)]
63
64mod client;
65mod error;
66mod limiter;
67mod models;
68mod query;
69
70pub use client::{JQuantsClient, DEFAULT_BASE_URL};
71pub use error::Error;
72pub use limiter::Plan;
73pub use models::{
74    AmBar, Breakdown, BulkListItem, Calendar, CrossShareholdingHolder, CrossShareholdingIssue,
75    CrossShareholdingsDoc, CursorPage, DailyBar, EarningsCalendar, EarningsDate, FinsDetails,
76    FinsDividend, FinsSummary, FlexString, FuturesBar, IndexDailyBar, InvestorType,
77    LargeVolumeHolder, LargeVolumeShareholdersDoc, MajorShareholder, MajorShareholdersDoc,
78    MarginAlert, MarginInterest, MinuteBar, Options225Bar, OptionsBar, PubReason, ShortRatio,
79    ShortSaleReport, StockMaster, TdBulk, TdFiles, TdFilesInner, TdList, TopixDailyBar, Valuation,
80};
81pub use query::{
82    BulkGetQuery, BulkListQuery, CalendarQuery, CodeDateQuery, EarningsDateQuery, EdinetQuery,
83    FinsQuery, FuturesBarsQuery, InvestorTypesQuery, MarginInterestQuery, MasterQuery,
84    OptionsBarsQuery, RangeQuery, ShortRatioQuery, ShortSaleReportQuery, TdListQuery,
85};