Skip to main content

financial_api/models/
fund.rs

1use serde::Deserialize;
2
3use crate::{
4    Adjustment, CompanyId, Cursor, DailyInterval, FundType, HolderRecordScope, ManagerId,
5    PortfolioAssetType, ReportType, Thscode, UnixMillis,
6};
7
8use super::{PriceBarItem, TimestampedItems};
9
10#[cfg(test)]
11mod tests;
12
13#[derive(Debug, Clone, PartialEq, Deserialize)]
14pub struct FundProfileItem {
15    pub thscode: Thscode,
16    pub ticker: String,
17    pub fund_name: Option<String>,
18    pub estab_date: Option<UnixMillis>,
19    pub company_id: Option<CompanyId>,
20    pub mgmt_name: Option<String>,
21    pub manager_name: Option<String>,
22    pub fund_scale: Option<f64>,
23    pub unit_nav: Option<f64>,
24    #[serde(default)]
25    pub manager_info: Vec<FundManagerRef>,
26    #[serde(default)]
27    pub trade_rule: Vec<FundTradeRule>,
28    #[serde(default)]
29    pub rate_info: Vec<FundRateInfo>,
30}
31
32#[derive(Debug, Clone, PartialEq, Deserialize)]
33pub struct FundManagerRef {
34    pub manager_id: ManagerId,
35    pub manager_name: String,
36    pub tenure_return_pct: Option<f64>,
37    pub tenure_days: Option<u64>,
38    pub start_date_ms: Option<UnixMillis>,
39    pub end_date_ms: Option<UnixMillis>,
40}
41
42#[derive(Debug, Clone, PartialEq, Deserialize)]
43pub struct FundTradeRule {
44    pub title: Option<String>,
45    pub display_time: Option<String>,
46    pub time_ms: Option<UnixMillis>,
47}
48
49#[derive(Debug, Clone, PartialEq, Deserialize)]
50pub struct FundRateInfo {
51    pub rate_type: Option<String>,
52    pub charge_mode: Option<String>,
53    pub condition: Option<String>,
54    pub standard_rate: Option<f64>,
55    pub discounted_rate: Option<f64>,
56}
57
58pub type FundProfileData = TimestampedItems<FundProfileItem>;
59
60#[derive(Debug, Clone, PartialEq, Deserialize)]
61pub struct FundHoldingsData {
62    pub timestamp: UnixMillis,
63    pub item: Vec<FundHoldingItem>,
64    pub total_stock_ratio_pct: Option<f64>,
65    pub total_bond_ratio_pct: Option<f64>,
66    pub total_fund_ratio_pct: Option<f64>,
67    pub turnover_rate_pct: Option<f64>,
68    pub stock_ratio_pct: Option<f64>,
69    pub main_industry: Option<String>,
70    pub concentration_ratio: Option<f64>,
71}
72
73#[derive(Debug, Clone, PartialEq, Deserialize)]
74pub struct FundHoldingItem {
75    pub thscode: Option<Thscode>,
76    pub ticker: Option<String>,
77    pub stock_name: Option<String>,
78    pub hold_ratio: Option<f64>,
79    pub asset_type: Option<PortfolioAssetType>,
80    pub position_capital: Option<f64>,
81    pub position_count: Option<f64>,
82    pub security_market_value_rate_pct: Option<f64>,
83    pub period_increase_rate_pct: Option<f64>,
84    pub investment_rank: Option<u64>,
85    pub start_date_ms: Option<UnixMillis>,
86    pub end_date_ms: Option<UnixMillis>,
87    pub publish_date_ms: Option<UnixMillis>,
88    pub modify_time_ms: Option<UnixMillis>,
89}
90
91pub type FundNavData = TimestampedItems<FundNavItem>;
92
93#[derive(Debug, Clone, PartialEq, Deserialize)]
94pub struct FundNavItem {
95    pub nav_date: UnixMillis,
96    pub unit_nav: Option<f64>,
97    pub adj_nav: Option<f64>,
98}
99
100pub type FundReturnsData = TimestampedItems<FundReturnsItem>;
101
102#[derive(Debug, Clone, PartialEq, Deserialize)]
103pub struct FundReturnsItem {
104    pub return_week: Option<f64>,
105    pub return_month: Option<f64>,
106    pub return_tmonth: Option<f64>,
107    pub return_hyear: Option<f64>,
108    pub return_year: Option<f64>,
109    pub return_twoyear: Option<f64>,
110    pub return_tyear: Option<f64>,
111    pub return_fyear: Option<f64>,
112    pub return_nowyear: Option<f64>,
113    pub return_now: Option<f64>,
114    pub peer_average_week: Option<f64>,
115    pub peer_average_month: Option<f64>,
116    pub peer_average_tmonth: Option<f64>,
117    pub peer_average_hyear: Option<f64>,
118    pub peer_average_year: Option<f64>,
119    pub peer_average_twoyear: Option<f64>,
120    pub peer_average_tyear: Option<f64>,
121    pub peer_average_fyear: Option<f64>,
122    pub rank_week: Option<u64>,
123    pub rank_month: Option<u64>,
124    pub rank_tmonth: Option<u64>,
125    pub rank_hyear: Option<u64>,
126    pub rank_year: Option<u64>,
127    pub rank_twoyear: Option<u64>,
128    pub rank_tyear: Option<u64>,
129    pub rank_fyear: Option<u64>,
130    pub rank_total_week: Option<u64>,
131    pub rank_total_month: Option<u64>,
132    pub rank_total_tmonth: Option<u64>,
133    pub rank_total_hyear: Option<u64>,
134    pub rank_total_year: Option<u64>,
135    pub rank_total_twoyear: Option<u64>,
136    pub rank_total_tyear: Option<u64>,
137    pub rank_total_fyear: Option<u64>,
138}
139
140pub type FundHoldersData = TimestampedItems<FundHolderItem>;
141
142#[derive(Debug, Clone, PartialEq, Deserialize)]
143pub struct FundHolderItem {
144    pub merge_scope: HolderRecordScope,
145    pub report_date_ms: UnixMillis,
146    pub ins_position: Option<f64>,
147    pub holder_amount: Option<u64>,
148    pub avg_holder_share: Option<f64>,
149    pub psnl_rate: Option<f64>,
150    pub mgmt_staff_hold_rate: Option<f64>,
151}
152
153#[derive(Debug, Clone, PartialEq, Deserialize)]
154pub struct FundTopHoldersData {
155    pub timestamp: UnixMillis,
156    pub limit: u8,
157    pub item: Vec<FundTopHolderItem>,
158}
159
160#[derive(Debug, Clone, PartialEq, Deserialize)]
161pub struct FundTopHolderItem {
162    pub holder_id: Option<String>,
163    pub holder_code: Option<String>,
164    pub holder_name: Option<String>,
165    pub holder_type: Option<String>,
166    pub rank: Option<u64>,
167    pub hold_share: Option<f64>,
168    pub hold_rate_pct: Option<f64>,
169    pub report_date_ms: Option<UnixMillis>,
170    pub publish_date_ms: Option<UnixMillis>,
171}
172
173#[derive(Debug, Clone, PartialEq, Deserialize)]
174pub struct FundDividendsData {
175    pub timestamp: UnixMillis,
176    pub dividend_count: Option<u64>,
177    pub dividend_total: Option<f64>,
178    pub item: Vec<FundDividendItem>,
179}
180
181#[derive(Debug, Clone, PartialEq, Deserialize)]
182pub struct FundDividendItem {
183    pub per_ten_cash_before_tax: Option<f64>,
184    pub per_ten_cash_after_tax: Option<f64>,
185    pub progress: Option<String>,
186    pub publish_date_ms: Option<UnixMillis>,
187    pub registration_date_ms: Option<UnixMillis>,
188    pub ex_dividend_date_ms: Option<UnixMillis>,
189    pub payment_date_ms: Option<UnixMillis>,
190    pub reinvestment_date_ms: Option<UnixMillis>,
191    pub profit_base_date_ms: Option<UnixMillis>,
192    pub in_dividend_date_ms: Option<UnixMillis>,
193}
194
195pub type FundDiagnosticsData = TimestampedItems<FundDiagnosticsItem>;
196
197#[derive(Debug, Clone, PartialEq, Deserialize)]
198pub struct FundDiagnosticsItem {
199    pub thscode: Thscode,
200    pub ticker: String,
201    pub fund_type: FundType,
202    pub peer_code: String,
203    pub dimensions: serde_json::Value,
204    pub peer_dimensions: serde_json::Value,
205    pub probabilities: serde_json::Value,
206    pub ranges: serde_json::Value,
207    pub resilience: serde_json::Value,
208    pub peer_resilience: serde_json::Value,
209}
210
211pub type FundFinancialIndicatorsData = TimestampedItems<FundFinancialIndicatorsItem>;
212
213#[derive(Debug, Clone, PartialEq, Deserialize)]
214pub struct FundFinancialIndicatorsItem {
215    pub start_date_ms: Option<UnixMillis>,
216    pub end_date_ms: Option<UnixMillis>,
217    pub publish_date_ms: Option<UnixMillis>,
218    pub distribution_profit: Option<f64>,
219    pub current_profit: Option<f64>,
220    pub current_income: Option<f64>,
221    pub distribution_share_profit: Option<f64>,
222    pub average_nav_profit_margin: Option<f64>,
223    pub average_share_current_profit: Option<f64>,
224    pub share_nav: Option<f64>,
225    pub sum_share_nav: Option<f64>,
226    pub asset_nav: Option<f64>,
227    pub sum_nav_rate: Option<f64>,
228    pub nav_rate: Option<f64>,
229}
230
231pub type FundIncomeStatementsData = TimestampedItems<FundIncomeStatementItem>;
232
233#[derive(Debug, Clone, PartialEq, Deserialize)]
234pub struct FundIncomeStatementItem {
235    pub start_date_ms: Option<UnixMillis>,
236    pub end_date_ms: Option<UnixMillis>,
237    pub publish_date_ms: Option<UnixMillis>,
238    pub income: Option<f64>,
239    pub investment_income: Option<f64>,
240    pub stock_investment_income: Option<f64>,
241    pub bond_investment_income: Option<f64>,
242    pub fund_investment_income: Option<f64>,
243    pub dividend_income: Option<f64>,
244    pub interest_income: Option<f64>,
245    pub fair_value_income: Option<f64>,
246    pub exchange_income: Option<f64>,
247    pub other_income: Option<f64>,
248    pub total_income: Option<f64>,
249    pub fee: Option<f64>,
250    pub manager_reward: Option<f64>,
251    pub custodian_fee: Option<f64>,
252    pub transaction_cost: Option<f64>,
253    pub tax_surcharge: Option<f64>,
254    pub total_fee: Option<f64>,
255    pub total_profit: Option<f64>,
256    pub net_profit: Option<f64>,
257}
258
259pub type FundBalanceSheetsData = TimestampedItems<FundBalanceSheetItem>;
260
261#[derive(Debug, Clone, PartialEq, Deserialize)]
262pub struct FundBalanceSheetItem {
263    pub start_date_ms: Option<UnixMillis>,
264    pub end_date_ms: Option<UnixMillis>,
265    pub publish_date_ms: Option<UnixMillis>,
266    pub total_assets: Option<f64>,
267    pub bank_deposit: Option<f64>,
268    pub fund_investment: Option<f64>,
269    pub stock_investment: Option<f64>,
270    pub bond_investment: Option<f64>,
271    pub transactional_financial_assets: Option<f64>,
272    pub other_assets: Option<f64>,
273    pub total_liability: Option<f64>,
274    pub other_liability: Option<f64>,
275    pub owner_total_equity: Option<f64>,
276    pub undistributed_profit: Option<f64>,
277    pub liability_and_owner_equity: Option<f64>,
278}
279
280pub type FundCompanyData = TimestampedItems<FundCompanyItem>;
281
282#[derive(Debug, Clone, PartialEq, Deserialize)]
283pub struct FundCompanyItem {
284    pub company_id: CompanyId,
285    pub company_name: String,
286    pub company_type: String,
287    pub established_date_ms: UnixMillis,
288    pub fund_count: u64,
289    pub scale: f64,
290}
291
292pub type FundIndustryAllocationData = TimestampedItems<FundIndustryAllocationItem>;
293
294#[derive(Debug, Clone, PartialEq, Deserialize)]
295pub struct FundIndustryAllocationItem {
296    pub report_period: Option<String>,
297    pub industry_name: Option<String>,
298    pub ratio_pct: Option<f64>,
299}
300
301pub type FundIndicatorHistoryData = TimestampedItems<FundIndicatorHistoryItem>;
302
303#[derive(Debug, Clone, PartialEq, Deserialize)]
304pub struct FundIndicatorHistoryItem {
305    pub date_ms: UnixMillis,
306    pub rsi_pct: Option<f64>,
307    pub donchian_channel: Option<f64>,
308    pub track_index_pe_ttm_five_year_percentile: Option<f64>,
309}
310
311pub type FundDrawdownsData = TimestampedItems<FundDrawdownsItem>;
312
313#[derive(Debug, Clone, PartialEq, Deserialize)]
314pub struct FundDrawdownsItem {
315    pub thscode: Thscode,
316    pub ticker: String,
317    pub week: Option<f64>,
318    pub month: Option<f64>,
319    pub tmonth: Option<f64>,
320    pub hyear: Option<f64>,
321    pub year: Option<f64>,
322    pub twoyear: Option<f64>,
323    pub tyear: Option<f64>,
324    pub fyear: Option<f64>,
325    pub nowyear: Option<f64>,
326    pub now: Option<f64>,
327}
328
329pub type FundManagerStyleData = TimestampedItems<FundManagerStyleItem>;
330
331#[derive(Debug, Clone, PartialEq, Deserialize)]
332pub struct FundManagerStyleItem {
333    pub representative_fund_thscode: Option<Thscode>,
334    pub representative_fund_ticker: Option<String>,
335    pub representative_fund_name: Option<String>,
336    pub investment_idea: Option<String>,
337    pub total_fund_scale: Option<f64>,
338    pub industry_preferences: Option<serde_json::Value>,
339}
340
341pub type FundManagerPerformanceData = TimestampedItems<FundManagerPerformanceItem>;
342
343#[derive(Debug, Clone, PartialEq, Deserialize)]
344pub struct FundManagerPerformanceItem {
345    pub date_ms: UnixMillis,
346    pub manager_return_pct: Option<f64>,
347    pub peer_return_pct: Option<f64>,
348    pub benchmark_return_pct: Option<f64>,
349}
350
351pub type FundManagerExperienceData = TimestampedItems<FundManagerExperienceItem>;
352
353#[derive(Debug, Clone, PartialEq, Deserialize)]
354pub struct FundManagerExperienceItem {
355    pub awards: serde_json::Value,
356    pub heavy_assets: serde_json::Value,
357    pub investment_history: serde_json::Value,
358}
359
360pub type FundManagerDetailData = TimestampedItems<FundManagerDetailItem>;
361
362#[derive(Debug, Clone, PartialEq, Deserialize)]
363pub struct FundManagerDetailItem {
364    pub manager_id: ManagerId,
365    pub manager_name: String,
366    pub sex: Option<String>,
367    pub degree: Option<String>,
368    pub company_id: Option<CompanyId>,
369    pub company_name: Option<String>,
370    pub resume: Option<String>,
371    pub photo_url: Option<String>,
372    pub annual_return_pct: Option<f64>,
373    pub maximum_return_pct: Option<f64>,
374    pub radar_comparison: Vec<FundManagerRadarComparison>,
375}
376
377/// One manager-versus-peer radar node aligned by category and horizon.
378#[derive(Debug, Clone, PartialEq, Deserialize)]
379pub struct FundManagerRadarComparison {
380    pub fund_category: String,
381    pub horizon: String,
382    pub manager_metrics: serde_json::Value,
383    pub manager_scores: serde_json::Value,
384    pub peer_average_scores: serde_json::Value,
385}
386
387#[derive(Debug, Clone, PartialEq, Deserialize)]
388pub struct FundMarketSnapshotData {
389    pub timestamp: Option<UnixMillis>,
390    pub item: Vec<FundMarketSnapshotItem>,
391}
392
393#[derive(Debug, Clone, PartialEq, Deserialize)]
394pub struct FundMarketSnapshotItem {
395    pub thscode: Thscode,
396    pub ticker: String,
397    pub last_price: f64,
398    pub open_price: f64,
399    pub high_price: f64,
400    pub low_price: f64,
401    pub prev_price: f64,
402    pub price_change_ratio_pct: f64,
403    pub price_change: f64,
404    pub price_amplitude_ratio_pct: Option<f64>,
405    pub volume: f64,
406    pub turnover: f64,
407    pub turnover_ratio_pct: Option<f64>,
408}
409
410#[derive(Debug, Clone, PartialEq, Deserialize)]
411pub struct FundMarketHistoricalData {
412    pub timestamp: UnixMillis,
413    pub thscode: Thscode,
414    pub interval: DailyInterval,
415    pub adjust: Option<Adjustment>,
416    pub item: Vec<PriceBarItem>,
417}
418
419#[derive(Debug, Clone, PartialEq, Deserialize)]
420pub struct FundNewsData {
421    pub timestamp: UnixMillis,
422    pub limit: u32,
423    pub offset: Option<Cursor>,
424    pub has_more: bool,
425    pub item: Vec<FundNewsItem>,
426}
427
428#[derive(Debug, Clone, PartialEq, Deserialize)]
429pub struct FundNewsItem {
430    pub id: String,
431    pub content_type: Option<String>,
432    pub title: String,
433    pub summary: Option<String>,
434    pub source: Option<String>,
435    pub url: Option<String>,
436    pub image_url: Option<String>,
437    pub author: Option<String>,
438    pub publish_time_ms: Option<UnixMillis>,
439    pub top: Option<bool>,
440}
441
442pub type FundOfferingsData = TimestampedItems<FundOfferingItem>;
443
444#[derive(Debug, Clone, PartialEq, Deserialize)]
445pub struct FundOfferingItem {
446    pub thscode: Option<Thscode>,
447    pub ticker: String,
448    pub subscription_start_ms: Option<UnixMillis>,
449    pub subscription_end_ms: Option<UnixMillis>,
450}
451
452pub type FundPortfolioHistoryData = TimestampedItems<FundPortfolioHistoryItem>;
453
454#[derive(Debug, Clone, PartialEq, Deserialize)]
455pub struct FundPortfolioHistoryItem {
456    pub thscode: Option<Thscode>,
457    pub ticker: Option<String>,
458    pub name: Option<String>,
459    pub asset_type: PortfolioAssetType,
460    pub hold_ratio: Option<f64>,
461    pub market_value: Option<f64>,
462    pub period_increase_pct: Option<f64>,
463    pub rank: Option<u64>,
464    pub report_type: ReportType,
465    pub end_date_ms: UnixMillis,
466}
467
468pub type FundReportDatesData = TimestampedItems<FundReportDateItem>;
469
470#[derive(Debug, Clone, PartialEq, Deserialize)]
471pub struct FundReportDateItem {
472    pub report_type: ReportType,
473    pub report_type_name: String,
474    pub start_date_ms: UnixMillis,
475    pub end_date_ms: UnixMillis,
476}
477
478pub type FundAssetAllocationData = TimestampedItems<FundAssetAllocationItem>;
479
480#[derive(Debug, Clone, PartialEq, Deserialize)]
481pub struct FundAssetAllocationItem {
482    pub report_date_ms: UnixMillis,
483    pub stock_ratio_pct: Option<f64>,
484    pub bond_ratio_pct: Option<f64>,
485    pub deposit_ratio_pct: Option<f64>,
486    pub other_ratio_pct: Option<f64>,
487}