akshare 0.1.12

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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
//! Stock trading data — billboard (龙虎榜), margin trading, block trades.
//!
//! Covers Python functions:
//! - `stock_billboard_details_em` — Billboard (龙虎榜) details
//! - `stock_billboard_statistic_em` — Billboard statistics
//! - `stock_billboard_org_statistic_em` — Organization trading statistics
//! - `stock_billboard_org_detail_em` — Organization seat tracking
//! - `stock_margin_detail_sse` — Margin trading details (SSE)
//! - `stock_margin_detail_szse` — Margin trading details (SZSE)
//! - `stock_margin_underlying_info_szse` — Margin trading underlying info
//! - `stock_dzjy_mdetail` — Block trade daily details
//! - `stock_dzjy_detail_cls` — Block trade daily statistics
//! - `stock_dzjy_hygt` — Active A-share block trade statistics

use crate::client::AkShareClient;
use crate::error::{Error, Result};
use crate::types::wire::EmDatacenterResp;

// ---------------------------------------------------------------------------
// Helper: format YYYYMMDD -> YYYY-MM-DD
// ---------------------------------------------------------------------------

fn fmt_date(date: &str) -> String {
    if date.len() >= 8 {
        format!("{}-{}-{}", &date[0..4], &date[4..6], &date[6..8])
    } else {
        date.to_string()
    }
}

// ---------------------------------------------------------------------------
// Implementation
// ---------------------------------------------------------------------------

impl AkShareClient {
    /// Get billboard (龙虎榜) details from Eastmoney.
    ///
    /// Python equivalent: `stock_billboard_details_em(date)`
    pub async fn stock_billboard_details_em(&self, date: &str) -> Result<Vec<serde_json::Value>> {
        let date_fmt = fmt_date(date);
        let filter = format!("(TRADE_DATE='{date_fmt}')");

        let response = crate::util::send_and_check(
            self.get("https://datacenter-web.eastmoney.com/api/data/v1/get")
                .query(&[
                    ("sortColumns", "SECURITY_CODE"),
                    ("sortTypes", "1"),
                    ("pageSize", "500"),
                    ("pageNumber", "1"),
                    ("reportName", "RPT_DAILYBILLBOARD_DETAILSNEW"),
                    ("columns", "ALL"),
                    ("filter", filter.as_str()),
                    ("source", "WEB"),
                    ("client", "WEB"),
                ]),
        )
        .await?;

        let payload: EmDatacenterResp = response.json().await.map_err(Error::from)?;
        let data = payload
            .result
            .ok_or_else(|| Error::upstream("billboard details missing result"))?
            .data;

        if data.is_empty() {
            return Err(Error::not_found("billboard details returned no data"));
        }
        Ok(data)
    }

    /// Get billboard statistics from Eastmoney.
    ///
    /// Python equivalent: `stock_billboard_statistic_em(period)`
    ///
    /// `period` is one of: "daily", "5days", "10days", "month", "year".
    pub async fn stock_billboard_statistic_em(
        &self,
        period: &str,
    ) -> Result<Vec<serde_json::Value>> {
        let period_code = match period {
            "daily" => "daily",
            "5days" => "5days",
            "10days" => "10days",
            "month" => "month",
            "year" => "year",
            _ => {
                return Err(Error::invalid_input(format!(
                    "unsupported period: {period}"
                )));
            }
        };

        let response = crate::util::send_and_check(
            self.get("https://datacenter-web.eastmoney.com/api/data/v1/get")
                .query(&[
                    ("sortColumns", "SECURITY_CODE"),
                    ("sortTypes", "1"),
                    ("pageSize", "500"),
                    ("pageNumber", "1"),
                    ("reportName", "RPT_DAILYBILLBOARD_STATISTIC"),
                    ("columns", "ALL"),
                    ("filter", format!("(PERIOD=\"{period_code}\")").as_str()),
                    ("source", "WEB"),
                    ("client", "WEB"),
                ]),
        )
        .await?;

        let payload: EmDatacenterResp = response.json().await.map_err(Error::from)?;
        let data = payload
            .result
            .ok_or_else(|| Error::upstream("billboard statistic missing result"))?
            .data;

        if data.is_empty() {
            return Err(Error::not_found("billboard statistic returned no data"));
        }
        Ok(data)
    }

    /// Get organization (institutional) trading statistics from Eastmoney.
    ///
    /// Python equivalent: `stock_billboard_org_statistic_em(period)`
    ///
    /// `period` is one of: "daily", "5days", "10days", "month", "year".
    pub async fn stock_billboard_org_statistic_em(
        &self,
        period: &str,
    ) -> Result<Vec<serde_json::Value>> {
        let period_code = match period {
            "daily" => "daily",
            "5days" => "5days",
            "10days" => "10days",
            "month" => "month",
            "year" => "year",
            _ => {
                return Err(Error::invalid_input(format!(
                    "unsupported period: {period}"
                )));
            }
        };

        let response = crate::util::send_and_check(
            self.get("https://datacenter-web.eastmoney.com/api/data/v1/get")
                .query(&[
                    ("sortColumns", "SECURITY_CODE"),
                    ("sortTypes", "1"),
                    ("pageSize", "500"),
                    ("pageNumber", "1"),
                    ("reportName", "RPT_DAILYBILLBOARD_ORG_STATISTIC"),
                    ("columns", "ALL"),
                    ("filter", format!("(PERIOD=\"{period_code}\")").as_str()),
                    ("source", "WEB"),
                    ("client", "WEB"),
                ]),
        )
        .await?;

        let payload: EmDatacenterResp = response.json().await.map_err(Error::from)?;
        let data = payload
            .result
            .ok_or_else(|| Error::upstream("billboard org statistic missing result"))?
            .data;

        if data.is_empty() {
            return Err(Error::not_found("billboard org statistic returned no data"));
        }
        Ok(data)
    }

    /// Get organization (seat) tracking details from Eastmoney.
    ///
    /// Python equivalent: `stock_billboard_org_detail_em(trade_date, symbol)`
    ///
    /// `symbol` is the institution/organization name to track.
    pub async fn stock_billboard_org_detail_em(
        &self,
        trade_date: &str,
        symbol: &str,
    ) -> Result<Vec<serde_json::Value>> {
        let date_fmt = fmt_date(trade_date);
        let filter =
            format!("(TRADE_DATE>='{date_fmt}')(TRADE_DATE<='{date_fmt}')(ORG_NAME=\"{symbol}\")");

        let response = crate::util::send_and_check(
            self.get("https://datacenter-web.eastmoney.com/api/data/v1/get")
                .query(&[
                    ("sortColumns", "SECURITY_CODE"),
                    ("sortTypes", "1"),
                    ("pageSize", "500"),
                    ("pageNumber", "1"),
                    ("reportName", "RPT_DAILYBILLBOARD_ORGDETAIL"),
                    ("columns", "ALL"),
                    ("filter", filter.as_str()),
                    ("source", "WEB"),
                    ("client", "WEB"),
                ]),
        )
        .await?;

        let payload: EmDatacenterResp = response.json().await.map_err(Error::from)?;
        let data = payload
            .result
            .ok_or_else(|| Error::upstream("billboard org detail missing result"))?
            .data;

        if data.is_empty() {
            return Err(Error::not_found("billboard org detail returned no data"));
        }
        Ok(data)
    }

    /// Get margin trading details from SSE (Shanghai Stock Exchange) via Eastmoney.
    ///
    /// Python equivalent: `stock_margin_detail_sse(date)`
    ///
    /// This is a raw JSON variant that fetches from the Eastmoney datacenter.
    /// For typed SSE margin data, use the `stock_margin_detail_sse` in `feature::margin_em`.
    pub async fn stock_margin_detail_sse_dc(&self, date: &str) -> Result<Vec<serde_json::Value>> {
        let date_fmt = fmt_date(date);

        let response = crate::util::send_and_check(
            self.get("https://datacenter-web.eastmoney.com/api/data/v1/get")
                .query(&[
                    ("sortColumns", "SECURITY_CODE"),
                    ("sortTypes", "1"),
                    ("pageSize", "500"),
                    ("pageNumber", "1"),
                    ("reportName", "RPTA_WEB_RZRQ_GGMX"),
                    ("columns", "ALL"),
                    ("filter", format!("(TRADE_DATE='{date_fmt}')").as_str()),
                    ("source", "WEB"),
                    ("client", "WEB"),
                ]),
        )
        .await?;

        let payload: EmDatacenterResp = response.json().await.map_err(Error::from)?;
        let data = payload
            .result
            .ok_or_else(|| Error::upstream("SSE margin detail missing result"))?
            .data;

        if data.is_empty() {
            return Err(Error::not_found("SSE margin detail returned no data"));
        }
        Ok(data)
    }

    /// Get margin trading details from SZSE (Shenzhen Stock Exchange) via Eastmoney.
    ///
    /// Python equivalent: `stock_margin_detail_szse(date)`
    ///
    /// This is a raw JSON variant that fetches from the Eastmoney datacenter.
    /// For typed SZSE margin data, use the `stock_margin_detail_szse` in `feature::margin_em`.
    pub async fn stock_margin_detail_szse_dc(&self, date: &str) -> Result<Vec<serde_json::Value>> {
        let date_fmt = fmt_date(date);

        let response = crate::util::send_and_check(
            self.get("https://datacenter-web.eastmoney.com/api/data/v1/get")
                .query(&[
                    ("sortColumns", "SECURITY_CODE"),
                    ("sortTypes", "1"),
                    ("pageSize", "500"),
                    ("pageNumber", "1"),
                    ("reportName", "RPTA_WEB_RZRQ_GGMX"),
                    ("columns", "ALL"),
                    ("filter", format!("(TRADE_DATE='{date_fmt}')").as_str()),
                    ("source", "WEB"),
                    ("client", "WEB"),
                ]),
        )
        .await?;

        let payload: EmDatacenterResp = response.json().await.map_err(Error::from)?;
        let data = payload
            .result
            .ok_or_else(|| Error::upstream("SZSE margin detail missing result"))?
            .data;

        if data.is_empty() {
            return Err(Error::not_found("SZSE margin detail returned no data"));
        }
        Ok(data)
    }

    /// Get margin trading underlying info from SZSE via Eastmoney.
    ///
    /// Python equivalent: `stock_margin_underlying_info_szse()`
    ///
    /// This is a raw JSON variant from the Eastmoney datacenter.
    pub async fn stock_margin_underlying_info_szse_dc(&self) -> Result<Vec<serde_json::Value>> {
        let response = crate::util::send_and_check(
            self.get("https://datacenter-web.eastmoney.com/api/data/v1/get")
                .query(&[
                    ("sortColumns", "SECURITY_CODE"),
                    ("sortTypes", "1"),
                    ("pageSize", "500"),
                    ("pageNumber", "1"),
                    ("reportName", "RPTA_WEB_RZRQ_MLGS"),
                    ("columns", "ALL"),
                    ("source", "WEB"),
                    ("client", "WEB"),
                ]),
        )
        .await?;

        let payload: EmDatacenterResp = response.json().await.map_err(Error::from)?;
        let data = payload
            .result
            .ok_or_else(|| Error::upstream("margin underlying info missing result"))?
            .data;

        if data.is_empty() {
            return Err(Error::not_found("margin underlying info returned no data"));
        }
        Ok(data)
    }

    /// Get block trade daily details from Eastmoney.
    ///
    /// Python equivalent: `stock_dzjy_mdetail(date)`
    pub async fn stock_dzjy_mdetail(&self, date: &str) -> Result<Vec<serde_json::Value>> {
        let date_fmt = fmt_date(date);
        let filter = format!("(TRADE_DATE='{date_fmt}')");

        let response = crate::util::send_and_check(
            self.get("https://datacenter-web.eastmoney.com/api/data/v1/get")
                .query(&[
                    ("sortColumns", "SECURITY_CODE"),
                    ("sortTypes", "1"),
                    ("pageSize", "500"),
                    ("pageNumber", "1"),
                    ("reportName", "RPT_DATA_BLOCKTRADE"),
                    ("columns", "ALL"),
                    ("filter", filter.as_str()),
                    ("source", "WEB"),
                    ("client", "WEB"),
                ]),
        )
        .await?;

        let payload: EmDatacenterResp = response.json().await.map_err(Error::from)?;
        let data = payload
            .result
            .ok_or_else(|| Error::upstream("block trade daily detail missing result"))?
            .data;

        if data.is_empty() {
            return Err(Error::not_found(
                "block trade daily detail returned no data",
            ));
        }
        Ok(data)
    }

    /// Get block trade daily statistics from Eastmoney.
    ///
    /// Python equivalent: `stock_dzjy_detail_cls(date)`
    pub async fn stock_dzjy_detail_cls(&self, date: &str) -> Result<Vec<serde_json::Value>> {
        let date_fmt = fmt_date(date);
        let filter = format!("(TRADE_DATE='{date_fmt}')");

        let response = crate::util::send_and_check(
            self.get("https://datacenter-web.eastmoney.com/api/data/v1/get")
                .query(&[
                    ("sortColumns", "SECURITY_CODE"),
                    ("sortTypes", "1"),
                    ("pageSize", "500"),
                    ("pageNumber", "1"),
                    ("reportName", "RPT_BLOCKTRADE_DETAILSNEW"),
                    ("columns", "ALL"),
                    ("filter", filter.as_str()),
                    ("source", "WEB"),
                    ("client", "WEB"),
                ]),
        )
        .await?;

        let payload: EmDatacenterResp = response.json().await.map_err(Error::from)?;
        let data = payload
            .result
            .ok_or_else(|| Error::upstream("block trade daily statistics missing result"))?
            .data;

        if data.is_empty() {
            return Err(Error::not_found(
                "block trade daily statistics returned no data",
            ));
        }
        Ok(data)
    }

    /// Get active A-share block trade statistics from Eastmoney.
    ///
    /// Python equivalent: `stock_dzjy_hygt()`
    pub async fn stock_dzjy_hygt(&self) -> Result<Vec<serde_json::Value>> {
        let response = crate::util::send_and_check(
            self.get("https://datacenter-web.eastmoney.com/api/data/v1/get")
                .query(&[
                    ("sortColumns", "SECURITY_CODE"),
                    ("sortTypes", "1"),
                    ("pageSize", "500"),
                    ("pageNumber", "1"),
                    ("reportName", "RPT_DZRZ_HY_GT"),
                    ("columns", "ALL"),
                    ("source", "WEB"),
                    ("client", "WEB"),
                ]),
        )
        .await?;

        let payload: EmDatacenterResp = response.json().await.map_err(Error::from)?;
        let data = payload
            .result
            .ok_or_else(|| Error::upstream("A-share block trade statistics missing result"))?
            .data;

        if data.is_empty() {
            return Err(Error::not_found(
                "A-share block trade statistics returned no data",
            ));
        }
        Ok(data)
    }
}