Struct JQuantsFreePlanClient

pub struct JQuantsFreePlanClient { /* private fields */ }

Free plan client for J-Quants API.

Example

use jquants_api_client::{
    DailyStockPricesApi, EarningsCalendarApi, FinancialStatementsApi, JQuantsBuilder, JQuantsFreePlanClient,
    JQuantsPlanClient, ListedIssueInfoApi, TradingCalendarApi, Paginatable
};

async {
    // Authenticate with a refresh token.
    let client = JQuantsFreePlanClient::new_from_refresh_token("your_refresh_token".to_string());

    // Get listed issue information.
    let response = client.get_listed_issue_info().send().await.unwrap();

    // Get stock prices.
    let response = client.get_daily_stock_prices().send().await.unwrap();

    // Paginate stock prices.
    let response = client.get_daily_stock_prices().fetch_all().await.unwrap();
    let response = client.get_daily_stock_prices().fetch_all_and_merge().await.unwrap();
    let stream = client.get_daily_stock_prices().fetch_pages_stream();

    // Get trading calendar.
    let response = client.get_trading_calendar().send().await.unwrap();

    // Get financial statements.
    let response = client.get_financial_statements().send().await.unwrap();

    // Paginate stock prices.
    let response = client.get_financial_statements().fetch_all().await.unwrap();
    let response = client.get_financial_statements().fetch_all_and_merge().await.unwrap();
    let stream = client.get_financial_statements().fetch_pages_stream();

    // Get earnings calendar.
    let response = client.get_earnings_calendar().send().await.unwrap();

    // Paginate earnings calendar.
    let response = client.get_earnings_calendar().fetch_all().await.unwrap();
    let response = client.get_earnings_calendar().fetch_all_and_merge().await.unwrap();
    let stream = client.get_earnings_calendar().fetch_pages_stream();
};

Trait Implementations

impl Clone for JQuantsFreePlanClient

fn clone(&self) -> JQuantsFreePlanClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl DailyStockPricesApi for JQuantsFreePlanClient

type Response = DailyStockPricesStandardPlanResponse

Response type for listed info API.

fn get_daily_stock_prices(&self) -> DailyStockPricesBuilder<Self::Response>

Get api builder for daily stock prices.

impl EarningsCalendarApi for JQuantsFreePlanClient

fn get_earnings_calendar(&self) -> EarningsCalendarBuilder

Get API builder for Earnings Calendar Data.

impl FinancialStatementsApi for JQuantsFreePlanClient

fn get_financial_statements(&self) -> FinancialStatementsBuilder

Get API builder for Financial Statements Data.

impl JQuantsPlanClient for JQuantsFreePlanClient

fn new(api_client: JQuantsApiClient) -> Self

Create a new client from an API client.

fn get_api_client(&self) -> &JQuantsApiClient

Get the API client.

fn new_from_refresh_token(refresh_token: String) -> Self

Create a new client from a refresh token.

fn new_from_account( mailaddress: &str, password: &str, ) -> impl Future<Output = Result<Self, JQuantsError>> + Send

Create a new client from an account.

fn get_current_refresh_token(&self) -> impl Future<Output = String> + Send

Get a current refresh token.

fn get_refresh_token_from_api( &self, mail_address: &str, password: &str, ) -> impl Future<Output = Result<String, JQuantsError>> + Send

Get a new refresh token from an account. But don’t update the ID token in the client.

fn get_id_token_from_api( &self, refresh_token: &str, ) -> impl Future<Output = Result<String, JQuantsError>> + Send

Get a new ID token from a refresh token. But don’t update the ID token in the client.

fn reset_refresh_token( &self, mail_address: &str, password: &str, ) -> impl Future<Output = Result<(), JQuantsError>> + Send

Renew the refresh token in the client.

fn reset_id_token( &self, ) -> impl Future<Output = Result<(), JQuantsError>> + Send

Renew the ID token in the client.

fn reauthenticate( &self, mail_address: &str, password: &str, ) -> impl Future<Output = Result<(), JQuantsError>> + Send

Reauthenticate with a new refresh token and a new id token.

impl ListedIssueInfoApi for JQuantsFreePlanClient

type Response = ListedIssueInfoLightPlanResponse

Response type for listed info API.

fn get_listed_issue_info(&self) -> ListedIssueInfoApiBuilder<Self::Response>

Get api builder for listed issue information.

impl TradingCalendarApi for JQuantsFreePlanClient

fn get_trading_calendar(&self) -> TradingCalendarBuilder

Get API builder for Trading Calendar.