akshare 0.1.0

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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259

//! CNIndex (国证指数) data — index listing, history, and constituents.

use serde::Deserialize;

use crate::client::AkShareClient;
use crate::error::{Error, Result};
use crate::types::{CniHistPoint, CniIndexItem};

// ---------------------------------------------------------------------------
// Wire types
// ---------------------------------------------------------------------------

#[derive(Debug, Deserialize)]
struct CniListEnvelope {
    data: Option<CniListData>,
}

#[derive(Debug, Deserialize)]
struct CniListData {
    rows: Option<Vec<Vec<serde_json::Value>>>,
}

#[derive(Debug, Deserialize)]
struct CniHistEnvelope {
    data: Option<CniHistData>,
}

#[derive(Debug, Deserialize)]
struct CniHistData {
    data: Option<Vec<Vec<serde_json::Value>>>,
}

// ---------------------------------------------------------------------------
// Public API
// ---------------------------------------------------------------------------

impl AkShareClient {
    /// 国证指数 — 最近交易日的所有指数.
    pub async fn index_all_cni(&self) -> Result<Vec<CniIndexItem>> {
        let response = self
            .get("https://www.cnindex.com.cn/index/indexList")
            .query(&[("channelCode", "-1"), ("rows", "2000"), ("pageNum", "1")])
            .send()
            .await
            .map_err(Error::from)?
            .error_for_status()
            .map_err(Error::from)?;

        let payload: CniListEnvelope = response.json().await.map_err(Error::from)?;
        let rows = payload.data.and_then(|d| d.rows).unwrap_or_default();

        let items: Vec<CniIndexItem> = rows
            .into_iter()
            .filter_map(|row| {
                if row.len() < 25 {
                    return None;
                }
                let code = row[2].as_str()?.to_string();
                let name = row[8].as_str().unwrap_or("").to_string();
                let sample_count = row[12].as_f64().unwrap_or(0.0);
                let close = row[13].as_f64().unwrap_or(0.0);
                let change_pct = row[14].as_f64().unwrap_or(0.0);
                let pe_ttm = row[16].as_f64().unwrap_or(0.0);
                let volume = row[18].as_f64().unwrap_or(0.0) / 100_000.0;
                let amount = row[19].as_f64().unwrap_or(0.0) / 100_000_000.0;
                let total_mv = row[20].as_f64().unwrap_or(0.0) / 100_000_000.0;
                let free_circ_mv = row[21].as_f64().unwrap_or(0.0) / 100_000_000.0;
                Some(CniIndexItem {
                    code,
                    name,
                    sample_count,
                    close,
                    change_pct,
                    pe_ttm,
                    volume,
                    amount,
                    total_mv,
                    free_circ_mv,
                })
            })
            .collect();

        if items.is_empty() {
            return Err(Error::not_found("cnindex returned no index items"));
        }
        Ok(items)
    }

    /// 国证指数 — 历史行情数据.
    pub async fn index_hist_cni(
        &self,
        symbol: &str,
        start_date: &str,
        end_date: &str,
    ) -> Result<Vec<CniHistPoint>> {
        // Format: YYYYMMDD -> YYYY-MM-DD
        let start = format_date_hyphen(start_date);
        let end = format_date_hyphen(end_date);

        let response = self
            .get("http://hq.cnindex.com.cn/market/market/getIndexDailyDataWithDataFormat")
            .query(&[
                ("indexCode", symbol),
                ("startDate", &start),
                ("endDate", &end),
                ("frequency", "day"),
            ])
            .send()
            .await
            .map_err(Error::from)?
            .error_for_status()
            .map_err(Error::from)?;

        let payload: CniHistEnvelope = response.json().await.map_err(Error::from)?;
        let data = payload.data.and_then(|d| d.data).unwrap_or_default();

        let mut points: Vec<CniHistPoint> = data
            .into_iter()
            .filter_map(|row| {
                if row.len() < 11 {
                    return None;
                }
                let date = row[0].as_str()?.to_string();
                let high = row[2].as_f64().unwrap_or(0.0);
                let open = row[3].as_f64().unwrap_or(0.0);
                let low = row[4].as_f64().unwrap_or(0.0);
                let close = row[5].as_f64().unwrap_or(0.0);
                let change_pct_raw = row[7].as_str().unwrap_or("0");
                let change_pct = change_pct_raw
                    .trim_end_matches('%')
                    .parse::<f64>()
                    .unwrap_or(0.0)
                    / 100.0;
                let amount = row[8].as_f64().unwrap_or(0.0);
                let volume = row[9].as_f64().unwrap_or(0.0);
                Some(CniHistPoint {
                    date,
                    open,
                    high,
                    low,
                    close,
                    change_pct,
                    volume,
                    amount,
                })
            })
            .collect();

        points.sort_by(|a, b| a.date.cmp(&b.date));
        if points.is_empty() {
            return Err(Error::not_found("cnindex returned no history data"));
        }
        Ok(points)
    }

    /// 国证指数 — 样本详情 (constituents).
    ///
    /// Returns a JSON array of objects with fields: date, code, name, industry,
    /// total_mv, weight.  The upstream returns an XLS; this endpoint returns
    /// JSON when called with the right accept header.
    pub async fn index_detail_cni(&self, symbol: &str) -> Result<Vec<serde_json::Value>> {
        let response = self
            .get("https://www.cnindex.com.cn/sample-detail/download-history")
            .query(&[("indexcode", symbol)])
            .send()
            .await
            .map_err(Error::from)?
            .error_for_status()
            .map_err(Error::from)?;

        let content_type = response
            .headers()
            .get("content-type")
            .and_then(|v| v.to_str().ok())
            .unwrap_or("")
            .to_string();

        if content_type.contains("json") {
            let data: Vec<serde_json::Value> = response.json().await.map_err(Error::from)?;
            Ok(data)
        } else {
            // The endpoint returns XLS; we cannot parse it in pure Rust without
            // a spreadsheet library. Return an error.
            Err(Error::upstream(
                "cnindex returns XLS format — not supported in pure Rust; \
                 use the JSON API or a third-party XLS parser",
            ))
        }
    }

    /// 国证指数 — 详细历史行情数据 (with date range).
    ///
    /// Same as `index_hist_cni` but with the Python-compatible name.
    pub async fn index_detail_hist_cni(
        &self,
        symbol: &str,
        start_date: &str,
        end_date: &str,
    ) -> Result<Vec<CniHistPoint>> {
        self.index_hist_cni(symbol, start_date, end_date).await
    }

    /// 国证指数 — 历史调样.
    ///
    /// Same as `index_detail_cni` but for adjustment records.
    pub async fn index_detail_hist_adjust_cni(
        &self,
        symbol: &str,
    ) -> Result<Vec<serde_json::Value>> {
        let response = self
            .get("http://www.cnindex.com.cn/sample-detail/download-adjustment")
            .query(&[("indexcode", symbol)])
            .send()
            .await
            .map_err(Error::from)?
            .error_for_status()
            .map_err(Error::from)?;

        let content_type = response
            .headers()
            .get("content-type")
            .and_then(|v| v.to_str().ok())
            .unwrap_or("")
            .to_string();

        if content_type.contains("json") {
            let data: Vec<serde_json::Value> = response.json().await.map_err(Error::from)?;
            Ok(data)
        } else {
            Err(Error::upstream(
                "cnindex adjustment returns XLS format — not supported in pure Rust",
            ))
        }
    }
}

// ---------------------------------------------------------------------------
// Helpers
// ---------------------------------------------------------------------------

fn format_date_hyphen(d: &str) -> String {
    let d = d.trim();
    if d.len() == 8 && d.chars().all(|c| c.is_ascii_digit()) {
        format!("{}-{}-{}", &d[..4], &d[4..6], &d[6..8])
    } else {
        d.to_string()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_format_date_hyphen() {
        assert_eq!(format_date_hyphen("20230114"), "2023-01-14");
        assert_eq!(format_date_hyphen("2023-01-14"), "2023-01-14");
    }
}