AShareHub

AShareHub — Chinese A-Share and ETF Market Data

You are an A-share market data assistant. Based on the user's query, use the asharehub Python SDK to fetch and present the data.

Official links: Skill website · API documentation · Get a free API key

Prerequisites

1. Get a Free API Key

Sign up at https://asharehub.com/en/console/register (free tier: 100 requests/day).

2. Set API Key

# Add to ~/.zshrc or ~/.bashrc
export ASHAREHUB_API_KEY="ash_your_key_here"

Then run:

source ~/.zshrc

3. Install SDK

pip install asharehub

Quick Start

from asharehub import AShareHub
import os

client = AShareHub(api_key=os.environ["ASHAREHUB_API_KEY"], version="v2")

# Daily prices for Ping An Bank
df = client.market_daily(symbol="000001.SZ", start_date="20240101", end_date="20240131")
print(df[["trade_date", "open", "high", "low", "close", "vol"]])

client.close()

All v2 date parameters use the compact YYYYMMDD form, for example 20260815. Never send YYYY-MM-DD values such as 2026-08-15 to a v2 endpoint.

Updating the skill & SDK

When the user asks to "update the skill / update the SDK / get the latest version", run the following directly — no extra confirmation needed:

• Update both at once (recommended, one line):

  curl -fsSL "https://asharehub.com/skill/install?lang=en" | bash && pip install -U asharehub
  

• Update this skill only (overwrites the endpoint docs in .claude/skills/asharehub/ with the latest):

  curl -fsSL "https://asharehub.com/skill/install?lang=en" | bash
  

• Update the Python SDK only:

  pip install -U asharehub
  

After updating, tell the user to re-run /asharehub to load the latest docs.

Available Data Endpoints

For the exact REST path, SDK signature, MCP signature, request parameters, and complete response-field list for all 47 interfaces, read api-contract.md. The endpoint topic files below provide explanations and examples; the generated contract file is authoritative when a summary differs.

Market Data

Capital Flows

Other

Indices

ETFs

Reference Data

Return Types

• All SDK methods return pd.DataFrame, same as Tushare.
• Numeric fields are float64, string fields are object, safe for direct arithmetic.
• Access columns as: df["close"], df.close, df.iloc[0].
• Empty results: returns empty DataFrame when no data matches — e.g. non-trading days, weekends, future dates. Check with df.empty.

Handling non-trading days

The API only contains data for actual trading days. If a query date has no data, the result is an empty DataFrame. Recommended pattern to get the most recent trading day's data:

# Omit dates — results are newest-first, so the first row is the latest trading day
df = client.market_daily(symbol="000001.SZ")

Workflow

1. Identify which data endpoint matches the user's query
2. Read the corresponding .md file in this directory for parameter and field details
3. Write and execute Python code using the asharehub SDK to fetch the data
4. Present results in a clear, readable format (tables, summaries, or charts)

Usage Examples

Get stock valuations

df = client.fundamentals(symbol="600519.SH", start_date="20240101")
print(df[["trade_date", "pe_ttm", "pb", "total_mv"]])

Check northbound flows

df = client.moneyflow_hsgt(start_date="20240301", end_date="20240315")
print(df[["trade_date", "north_money", "south_money"]])

Chip distribution analysis

df = client.chip_distribution(symbol="000001.SZ", start_date="20240301")
print(df[["trade_date", "winner_rate", "weight_avg"]])

Index performance

df = client.index_daily(symbol="000300.SH", start_date="20240101")  # CSI 300
print(df[["trade_date", "close", "pct_chg"]])

FX rates

df = client.fx_daily(symbol="USDCNH.FXCM", start_date="20240101")
print(df[["trade_date", "bid_close", "ask_close"]])

Quarterly financials

df = client.financial_indicators(symbol="000001.SZ")
print(df[["end_date", "roe", "eps", "netprofit_margin"]])

Stock Code Format

• Shenzhen: 000001.SZ (Main), 300001.SZ (ChiNext), 002001.SZ (SME)
• Shanghai: 600000.SH (Main), 688001.SH (STAR Market)
• Hong Kong: 00700.HK (five digits; preserve leading zeroes)

Common Index Codes

Exact Command Reference

Read api-contract.md. It is generated from the V2 OpenAPI schema and contains all 47 SDK/MCP signatures and every response field. V2 result caps are managed by the server; limit and offset are not public V2 or SDK parameters.

FAQ

Error: ASHAREHUB_API_KEY not set → Add export ASHAREHUB_API_KEY="ash_..." to ~/.zshrc and run source ~/.zshrc

How to get an API key? → Free signup at https://asharehub.com/console/register (100 requests/day, no credit card)

Empty results returned → Check stock code format (e.g. 000001.SZ not 000001), and ensure date range has trading days

Rate limit exceeded (429) → Free tier allows 100 requests/day. Upgrade at https://asharehub.com/console/pricing

How to find a stock code? → Use the full code with exchange suffix: Shenzhen = .SZ, Shanghai = .SH

Reference

• API Documentation: https://asharehub.com/docs
• SDK on PyPI: https://pypi.org/project/asharehub/
• Website: https://asharehub.com