akshare 0.1.2

100% pure Rust implementation of akshare — unified access to Chinese and global financial market data APIs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

//! # akshare-rs
//!
//! 100% pure Rust implementation of [akshare](https://github.com/akfamily/akshare) —
//! unified access to Chinese and global financial market data APIs.
//!
//! ## Quick Start
//!
//! ```rust,no_run
//! use akshare::AkShareClient;
//!
//! # async fn example() -> Result<(), akshare::Error> {
//! let client = AkShareClient::new();
//!
//! // A-share quote
//! let quote = client.a_share_quote("600000").await?;
//!
//! // A-share candles
//! let candles = client.a_share_candles("600000", "qfq", 60).await?;
//!
//! // US stock candles
//! let us_candles = client.us_candles("AAPL", 30).await?;
//!
//! // HK stock quote
//! let hk_quote = client.hk_quote("00593").await?;
//! # Ok(())
//! # }
//! ```
//!
//! ## Data Sources
//!
//! | Provider | Coverage |
//! |----------|----------|
//! | **Eastmoney** | A-share search, quotes, klines, sectors, billboard, capital flow |
//! | **Sina Finance** | A-share real-time, US daily, bonds, forex |
//! | **Tencent Finance** | A-share/HK real-time quotes and klines |
//! | **Yahoo Finance** | HK/US/global stock charts |
//! | **Stooq** | US/global stock CSV data (fallback) |
//! | **SEC EDGAR** | US company fundamentals and filings |
//! | **Tushare Pro** | Chinese market daily data, financials, trade calendar |
//!
//! ## Module Overview
//!
//! ### Equity Markets
//!
//! | Module | Description | Functions |
//! |--------|-------------|-----------|
//! | [`stock`] | A-share, HK, US stock data | 433 |
//! | [`index`] | A-share, HK, global indices | 97 |
//!
//! ### Derivatives
//!
//! | Module | Description | Functions |
//! |--------|-------------|-----------|
//! | [`futures`] | Domestic exchanges, spot prices, warehouse stocks | 109 |
//! | [`option`] | SSE, CZCE, CFFEX, commodity options | 48 |
//!
//! ### Funds & Fixed Income
//!
//! | Module | Description | Functions |
//! |--------|-------------|-----------|
//! | [`fund`] | ETF, LOF, ranked lists, holdings | 98 |
//! | [`bond`] | Government, corporate, convertible bonds | 51 |
//! | [`reits`] | REITs data from Eastmoney | 5 |
//!
//! ### Macro & Economy
//!
//! | Module | Description | Functions |
//! |--------|-------------|-----------|
//! | [`macro_data`] | China, US, EU, UK, Japan GDP/CPI/PMI | 423 |
//! | [`economy`] | Events, articles, NLP sentiment | 62 |
//!
//! ### FX, Crypto & Commodities
//!
//! | Module | Description | Functions |
//! |--------|-------------|-----------|
//! | [`forex`] | BOC rates, cross rates, real-time | 19 |
//! | [`crypto`] | Bitcoin and major crypto data | 4 |
//! | [`commodity`] | Commodity prices, carbon trading | 9 |
//! | [`spot`] | Spot market prices (SGE, hog, futures) | 14 |
//!
//! ### Other
//!
//! | Module | Description | Functions |
//! |--------|-------------|-----------|
//! | [`news`] | Financial news from multiple sources | 6 |
//! | [`bank`] | Banking regulatory data | 1 |
//! | [`cal`] | Calendar, volatility calculations | 2 |
//! | [`tool`] | Trade calendar, utilities | 2 |
//! | [`provider`] | Data provider abstractions | 12 |
//!
//! ## MSRV
//!
//! Rust **1.85** (edition 2024)

// Pedantic/nursery suppressions for large categories that don't improve code quality:
// - missing_errors_doc: 1400+ functions return Result; adding docs to all is impractical
// - similar_names: financial code naturally has similar variable names (e.g. open_price/open_value)
// - doc_markdown: Chinese financial terms in docs don't need backticks
#![allow(
    clippy::missing_errors_doc,
    clippy::similar_names,
    clippy::doc_markdown,
    clippy::unused_async, // 45 stubs that must stay async for API compatibility
    clippy::cast_possible_truncation, // financial data: f64→i64, usize→i32, etc. are intentional
    clippy::cast_precision_loss,      // i64→f64, usize→f64 precision loss acceptable for display
    clippy::cast_possible_wrap,       // usize→i64 wrap is safe for data sizes in practice
    clippy::cast_sign_loss,           // i64→u64, f64→u64 sign loss acceptable for volume/prices
    clippy::redundant_pub_crate,      // pub(crate) items in private modules are intentional
    clippy::option_if_let_else,       // if-let is often clearer than map_or_else for complex cases
    clippy::too_many_lines,           // some parsing functions are inherently long
    clippy::missing_panics_doc,       // internal parsing helpers; panics are documented in context
)]

// Equity Markets
pub mod index;
pub mod stock;

// Derivatives
pub mod futures;
pub mod option;

// Funds & Fixed Income
pub mod bond;
pub mod fund;
pub mod reits;

// Macro & Economy
pub mod economy;
pub mod macro_data;

// FX, Crypto & Commodities
pub mod commodity;
pub mod crypto;
pub mod forex;
pub mod spot;

// Other
pub mod bank;
pub mod cal;
pub mod news;
pub mod provider;
pub mod tool;

// Internal
mod client;
mod error;
pub mod market;
pub mod types;
mod util;

pub use client::{AkShareClient, AkShareClientBuilder};
pub use error::{Error, ErrorKind, Result};
pub use market::{detect_market, normalize_a_share_symbol, normalize_hk_symbol};
pub use types::*;