Skip to main content

Crate akshare

Crate akshare 

Source
Expand description

§akshare-rs

100% pure Rust implementation of akshare — unified access to Chinese and global financial market data APIs.

§Quick Start

use akshare::AkShareClient;

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?;

§Data Sources

ProviderCoverage
EastmoneyA-share search, quotes, klines, sectors, billboard, capital flow
Sina FinanceA-share real-time, US daily, bonds, forex
Tencent FinanceA-share/HK real-time quotes and klines
Yahoo FinanceHK/US/global stock charts
StooqUS/global stock CSV data (fallback)
SEC EDGARUS company fundamentals and filings
Tushare ProChinese market daily data, financials, trade calendar

§Module Overview

§Equity Markets

ModuleDescriptionFunctions
stockA-share, HK, US stock data433
indexA-share, HK, global indices97

§Derivatives

ModuleDescriptionFunctions
futuresDomestic exchanges, spot prices, warehouse stocks109
optionSSE, CZCE, CFFEX, commodity options48

§Funds & Fixed Income

ModuleDescriptionFunctions
fundETF, LOF, ranked lists, holdings98
bondGovernment, corporate, convertible bonds51
reitsREITs data from Eastmoney5

§Macro & Economy

ModuleDescriptionFunctions
macro_dataChina, US, EU, UK, Japan GDP/CPI/PMI423
economyEvents, articles, NLP sentiment62

§FX, Crypto & Commodities

ModuleDescriptionFunctions
forexBOC rates, cross rates, real-time19
cryptoBitcoin and major crypto data4
commodityCommodity prices, carbon trading9
spotSpot market prices (SGE, hog, futures)14

§Other

ModuleDescriptionFunctions
newsFinancial news from multiple sources6
bankBanking regulatory data1
calCalendar, volatility calculations2
toolTrade calendar, utilities2
providerData provider abstractions12

§MSRV

Rust 1.85 (edition 2024)

Re-exports§

pub use market::detect_market;
pub use market::normalize_a_share_symbol;
pub use market::normalize_hk_symbol;
pub use types::*;

Modules§

bank
Banking regulatory data.
bond
Bond data: government, convertible, corporate, spot, buyback, CBond indices, ChinaMoney yields, Sina/THS sources, SSE summaries, CNINFO issuance, NAFMII, and Eastmoney rates.
cal
Realized volatility calculations.
commodity
Commodity data: energy (oil, carbon), spot prices.
crypto
Cryptocurrency spot price data.
economy
Economy-related alternative data: AMAC fund, air quality, auto sales, box office, NLP sentiment, articles, events, fortune, other.
forex
Forex rate data: Bank of China, Sina, Eastmoney, FX, currency.
fund
Fund data: ETF, open-end, money market, graded, LOF, Xueqiu, QDII, plus ranking, portfolio, rating, scale, report, announcement, AUM, etc.
futures
Futures data: exchanges, realtime, historical, derivatives.
index
Index data: A-share, HK, global, Shenwan, CNIndex, CX, QVIX, and more.
macro_data
Macro-economic data: China, US, Euro, UK, and global indicators, rates.
market
Market detection and symbol normalization utilities.
news
News search and aggregation.
option
Option data — comprehensive option market data from multiple sources.
provider
reits
REITs data.
spot
Spot market data: Shanghai Gold Exchange, hog prices, QH commodity prices.
stock
Stock data: A-share, HK, US equities from multiple providers.
tool
Utility tools.
types
Shared types used across all modules.

Structs§

AkShareClient
AkShare Rust client — 100% pure Rust, no Python/JS/FFI.
AkShareClientBuilder
Error

Enums§

ErrorKind

Type Aliases§

Result