Skip to main content

financial_api/
endpoints.rs

1/// A stable name and path for one supported REST capability.
2#[derive(Debug, Clone, Copy, PartialEq, Eq)]
3pub struct EndpointInfo {
4    pub name: &'static str,
5    pub path: &'static str,
6}
7
8macro_rules! define_endpoints {
9    ($($constant:ident => ($name:literal, $path:literal)),+ $(,)?) => {
10        $(pub(crate) const $constant: &str = $path;)+
11
12        /// Every currently available REST endpoint in the upstream contract.
13        pub const SUPPORTED_ENDPOINTS: &[EndpointInfo] = &[
14            $(EndpointInfo { name: $name, path: $path },)+
15        ];
16    };
17}
18
19define_endpoints! {
20    INDEX_CATALOG => ("index_catalog_ths_index_list", "/api/a-share-index/catalog/ths-index-list"),
21    INDEX_CONSTITUENTS => ("index_constituents_ths_stock_list", "/api/a-share-index/constituents/ths-stock-list"),
22    INDEX_HISTORICAL => ("index_prices_historical", "/api/a-share-index/prices/historical"),
23    INDEX_SNAPSHOT => ("index_prices_snapshot", "/api/a-share-index/prices/snapshot"),
24    AUCTION_BENCHMARK => ("a_share_auction_short_term_benchmark", "/api/a-share/auction/short-term-benchmark"),
25    AUCTION_SNAPSHOT => ("a_share_auction_snapshot", "/api/a-share/auction/snapshot"),
26    TRADING_DAYS => ("calendar_trading_days", "/api/a-share/calendar/trading-days"),
27    ADJUSTMENT_FACTORS => ("corp_actions_adjustment_factors", "/api/a-share/corporate-actions/adjustment-factors"),
28    BALANCE_SHEETS => ("financials_balance_sheets", "/api/a-share/financials/balance-sheets"),
29    CASH_FLOW_STATEMENTS => ("financials_cash_flow_statements", "/api/a-share/financials/cash-flow-statements"),
30    INCOME_STATEMENTS => ("financials_income_statements", "/api/a-share/financials/income-statements"),
31    FINANCIAL_INDICATORS => ("financials_indicators", "/api/a-share/financials/indicators"),
32    PRICES_HISTORICAL => ("prices_historical", "/api/a-share/prices/historical"),
33    PRICES_SNAPSHOT => ("prices_snapshot", "/api/a-share/prices/snapshot"),
34    ANOMALY_LIST => ("special_data_anomaly_analysis_list", "/api/a-share/special-data/anomaly-analysis-list"),
35    ANOMALY_STOCK => ("special_data_anomaly_analysis_stock", "/api/a-share/special-data/anomaly-analysis-stock"),
36    DRAGON_TIGER => ("special_data_dragon_tiger_list", "/api/a-share/special-data/dragon-tiger-list"),
37    HOT_STOCK_LIST => ("special_data_hot_stock_list", "/api/a-share/special-data/hot-stock-list"),
38    HOT_STOCK_HISTORY => ("special_data_hot_stock_list_history", "/api/a-share/special-data/hot-stock-list-history"),
39    HOT_STOCK_TREND => ("special_data_hot_stock_rank_trend", "/api/a-share/special-data/hot-stock-rank-trend"),
40    LIMIT_BREAK_POOL => ("special_data_limit_break_pool", "/api/a-share/special-data/limit-break-pool"),
41    LIMIT_DOWN_POOL => ("special_data_limit_down_pool", "/api/a-share/special-data/limit-down-pool"),
42    LIMIT_UP_LADDER => ("special_data_limit_up_ladder", "/api/a-share/special-data/limit-up-ladder"),
43    LIMIT_UP_POOL => ("special_data_limit_up_pool", "/api/a-share/special-data/limit-up-pool"),
44    SKYROCKET_LIST => ("special_data_skyrocket_list", "/api/a-share/special-data/skyrocket-list"),
45    VALUATIONS_SNAPSHOT => ("a_share_valuations_snapshot", "/api/a-share/valuations/snapshot"),
46    DUMP_ADJUSTMENT_FACTORS => ("market_dump_adjustment_factors", "/api/dump/market-dumps/adjustment-factors/download-url"),
47    DUMP_DAILY_K_10D => ("market_dump_daily_k_10d", "/api/dump/market-dumps/daily-k-10d/download-url"),
48    DUMP_DAILY_K => ("market_dump_daily_k", "/api/dump/market-dumps/daily-k/download-url"),
49    FUND_COMPANY_DETAIL => ("fund_companies_detail", "/api/fund/companies/detail"),
50    FUND_DIVIDENDS => ("fund_corporate_actions_dividends", "/api/fund/corporate-actions/dividends"),
51    FUND_DIAGNOSTICS => ("fund_diagnostics_detail", "/api/fund/diagnostics/detail"),
52    FUND_BALANCE_SHEETS => ("fund_financials_balance_sheets", "/api/fund/financials/balance-sheets"),
53    FUND_INCOME_STATEMENTS => ("fund_financials_income_statements", "/api/fund/financials/income-statements"),
54    FUND_INDICATORS => ("fund_financials_indicators", "/api/fund/financials/indicators"),
55    FUND_HOLDERS_DETAIL => ("fund_holders_detail", "/api/fund/holders/detail"),
56    FUND_HOLDERS_TOP => ("fund_holders_top", "/api/fund/holders/top"),
57    FUND_MANAGER_DETAIL => ("fund_managers_detail", "/api/fund/managers/detail"),
58    FUND_MANAGER_EXPERIENCE => ("fund_managers_experience", "/api/fund/managers/experience"),
59    FUND_MANAGER_STYLE => ("fund_managers_investment_style", "/api/fund/managers/investment-style"),
60    FUND_MANAGER_PERFORMANCE => ("fund_managers_performance", "/api/fund/managers/performance"),
61    FUND_MARKET_HISTORICAL => ("fund_market_historical", "/api/fund/market/historical"),
62    FUND_MARKET_SNAPSHOT => ("fund_market_snapshot", "/api/fund/market/snapshot"),
63    FUND_NEWS => ("fund_news_article_list", "/api/fund/news/article-list"),
64    FUND_OFFERINGS => ("fund_offerings_list", "/api/fund/offerings/list"),
65    FUND_DRAWDOWNS => ("fund_performance_drawdowns", "/api/fund/performance/drawdowns"),
66    FUND_INDICATORS_HISTORICAL => ("fund_performance_indicators_historical", "/api/fund/performance/indicators-historical"),
67    FUND_NAV => ("fund_performance_nav", "/api/fund/performance/nav"),
68    FUND_RETURNS => ("fund_performance_returns", "/api/fund/performance/returns"),
69    FUND_ASSET_ALLOCATION => ("fund_portfolio_asset_allocation", "/api/fund/portfolio/asset-allocation"),
70    FUND_BOND_HISTORY => ("fund_portfolio_bond_history", "/api/fund/portfolio/bond-history"),
71    FUND_BOND_REPORT_DATES => ("fund_portfolio_bond_report_dates", "/api/fund/portfolio/bond-report-dates"),
72    FUND_HOLDINGS => ("fund_portfolio_holdings", "/api/fund/portfolio/holdings"),
73    FUND_INDUSTRY_ALLOCATION => ("fund_portfolio_industry_allocation", "/api/fund/portfolio/industry-allocation"),
74    FUND_STOCK_HISTORY => ("fund_portfolio_stock_history", "/api/fund/portfolio/stock-history"),
75    FUND_STOCK_REPORT_DATES => ("fund_portfolio_stock_report_dates", "/api/fund/portfolio/stock-report-dates"),
76    FUND_PROFILE => ("fund_profile_detail", "/api/fund/profile/detail"),
77    TICKERS_LIST => ("tickers_list", "/api/meta/tickers/list"),
78    TICKERS_SEARCH => ("tickers_search", "/api/meta/tickers/search"),
79}