fundamental_context.hpp

Go to the documentation of this file.

#pragma once
 
#include "async_result.hpp"
#include "callback.hpp"
#include "config.hpp"
#include "types.hpp"
#include <optional>
#include <string>
#include <vector>
 
typedef struct lb_fundamental_context_t lb_fundamental_context_t;
 
namespace longbridge {
namespace fundamental {
 
enum class FinancialReportKind
{
  IncomeStatement = 0,
  BalanceSheet    = 1,
  CashFlow        = 2,
  All             = 3,
};
enum class FinancialReportPeriod
{
  Annual        = 0,
  SemiAnnual    = 1,
  Q1            = 2,
  Q2            = 3,
  Q3            = 4,
  QuarterlyFull = 5,
};
enum class IndustryRankIndicator
{
  LeadingGainer   = 0,
  TodayTrend      = 1,
  Popularity      = 2,
  MarketCap       = 3,
  Revenue         = 4,
  RevenueGrowth   = 5,
  NetProfit       = 6,
  NetProfitGrowth = 7,
};
enum class IndustryRankSortType
{
  Single = 0,
  Multi  = 1,
};
 
class FundamentalContext
{
private:
  const lb_fundamental_context_t* ctx_;
 
public:
  FundamentalContext();
  FundamentalContext(const lb_fundamental_context_t* ctx);
  FundamentalContext(const FundamentalContext& ctx);
  FundamentalContext(FundamentalContext&& ctx);
  ~FundamentalContext();
  FundamentalContext& operator=(const FundamentalContext& ctx);
 
  static FundamentalContext create(const Config& config);
 
  void financial_report(const std::string& symbol, FinancialReportKind kind, std::optional<FinancialReportPeriod> period,
                        AsyncCallback<FundamentalContext, FinancialReports> callback) const;
 
  void institution_rating(const std::string& symbol,
                          AsyncCallback<FundamentalContext, InstitutionRating> callback) const;
 
  void institution_rating_detail(const std::string& symbol,
                                 AsyncCallback<FundamentalContext, InstitutionRatingDetail> callback) const;
 
  void dividend(const std::string& symbol,
                AsyncCallback<FundamentalContext, DividendList> callback) const;
 
  void dividend_detail(const std::string& symbol,
                       AsyncCallback<FundamentalContext, DividendList> callback) const;
 
  void forecast_eps(const std::string& symbol,
                    AsyncCallback<FundamentalContext, ForecastEps> callback) const;
 
  void valuation(const std::string& symbol,
                 AsyncCallback<FundamentalContext, ValuationData> callback) const;
 
  void valuation_history(const std::string& symbol,
                         AsyncCallback<FundamentalContext, ValuationHistoryResponse> callback) const;
 
  void company(const std::string& symbol,
               AsyncCallback<FundamentalContext, CompanyOverview> callback) const;
 
  void shareholder(const std::string& symbol,
                   AsyncCallback<FundamentalContext, ShareholderList> callback) const;
 
  void fund_holder(const std::string& symbol,
                   AsyncCallback<FundamentalContext, FundHolders> callback) const;
 
  void corp_action(const std::string& symbol,
                   AsyncCallback<FundamentalContext, CorpActions> callback) const;
 
  void invest_relation(const std::string& symbol,
                       AsyncCallback<FundamentalContext, InvestRelations> callback) const;
 
  void operating(const std::string& symbol,
                 AsyncCallback<FundamentalContext, OperatingList> callback) const;
 
  void consensus(const std::string& symbol,
                 AsyncCallback<FundamentalContext, FinancialConsensus> callback) const;
 
  void industry_valuation(const std::string& symbol,
                          AsyncCallback<FundamentalContext, IndustryValuationList> callback) const;
 
  void industry_valuation_dist(const std::string& symbol,
                               AsyncCallback<FundamentalContext, IndustryValuationDist> callback) const;
 
  void executive(const std::string& symbol,
                 AsyncCallback<FundamentalContext, ExecutiveList> callback) const;
 
  void buyback(const std::string& symbol,
               AsyncCallback<FundamentalContext, BuybackData> callback) const;
 
  // TODO: temporarily disabled — endpoint not yet open (/v1/quote/ratings)
  // /// Get stock ratings
  // void ratings(const std::string& symbol,
  //              AsyncCallback<FundamentalContext, StockRatings> callback) const;
 
  void business_segments(const std::string& symbol,
                          AsyncCallback<FundamentalContext, BusinessSegments> callback) const;
 
  void business_segments_history(const std::string& symbol,
                                  const char* report,
                                  const char* cate,
                                  AsyncCallback<FundamentalContext, BusinessSegmentsHistory> callback) const;
 
  void institution_rating_views(const std::string& symbol,
                                 AsyncCallback<FundamentalContext, InstitutionRatingViews> callback) const;
 
  void industry_rank(Market market,
                     IndustryRankIndicator indicator,
                     IndustryRankSortType sort_type,
                     uint32_t limit,
                     AsyncCallback<FundamentalContext, IndustryRankResponse> callback) const;
 
  void industry_peers(const std::string& symbol,
                      const std::string& market,
                      const char* industry_id,
                      AsyncCallback<FundamentalContext, IndustryPeersResponse> callback) const;
 
  void financial_report_snapshot(const std::string& symbol,
                                  const char* report,
                                  int32_t fiscal_year,
                                  const char* fiscal_period,
                                  AsyncCallback<FundamentalContext, FinancialReportSnapshot> callback) const;
 
  void shareholder_top(const std::string& symbol,
                       AsyncCallback<FundamentalContext, std::string> callback) const;
 
  void shareholder_detail(const std::string& symbol,
                          int64_t object_id,
                          AsyncCallback<FundamentalContext, std::string> callback) const;
 
  void valuation_comparison(const std::string& symbol,
                            const std::string& currency,
                            const std::vector<std::string>* comparison_symbols,
                            AsyncCallback<FundamentalContext, ValuationComparisonResponse> callback) const;
 
  void etf_asset_allocation(
    const std::string& symbol,
    AsyncCallback<FundamentalContext, AssetAllocationResponse> callback) const;
};
 
} // namespace fundamental
} // namespace longbridge