Doc search (units / conventions / misuse) API
Search the product docs: field units, conventions, common misuse and cross-market differences. Progressive loading to save context: no params returns the CATALOG (slug + title + one-liner); `q=keyword` returns matching docs as SUMMARIES (with a snippet, NOT the full text); `slug=xxx` returns that one doc in full. It never dumps every doc at once — go catalog first, then fetch the single doc you need. `lang`: `zh` (default) or `en`. Free tier (no key required), but calls still count toward usage and rate limits.
GET /v1/wikiGET /v1/wiki?q=%E5%A4%AA%E6%9E%81%E5%AE%9E%E4%B8%9Acurl "https://api.ashareapi.com/v1/wiki?q=%E5%A4%AA%E6%9E%81%E5%AE%9E%E4%B8%9A"q · slug · lang* = requiredQuick start
Replace the key below with yours (free endpoints need no key):
# 注：q 的值已做 URL 编码（含 [ ] 空格 等）
# 免费端点：无需 API Key（匿名即可调用）
curl "https://api.ashareapi.com/v1/wiki?q=%E5%A4%AA%E6%9E%81%E5%AE%9E%E4%B8%9A"import requests
r = requests.get(
"https://api.ashareapi.com/v1/wiki",
params={},
timeout=30,
)
print(r.json())const r = await fetch("https://api.ashareapi.com/v1/wiki?q=%E5%A4%AA%E6%9E%81%E5%AE%9E%E4%B8%9A");
console.log(await r.json());Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| q | string | No | Keyword: a stock name (Chinese works) or a code |
| slug | string | No | 取某一篇全文（如 units / kline-fields）；留空=不用 |
| lang | string | No | 语言：zh（默认）/ en |
qstringslugstringlangstringUnified envelope: { ok, endpoint, tier, elapsed_ms, source, data }
Rows live in `data`; when upstream returns nothing you get `ok:false` and the call is not counted.
Free endpoints need no key (anonymous 5/min — 250 bars per request, 100k rows per day; solve one PoW challenge for 15/min). Paid tiers: Trial 30 · Standard 120 · Pro 300 · Unlimited 600 per minute; buyout packs are capped by total calls and never expire.
See the error code table →FAQ
General (applies to every endpoint)
Free endpoints do not: health, challenge, quote, kline, hot, market-overview and changedist work anonymously. Paid endpoints do: send `Authorization: Bearer
No. When the upstream fails or returns nothing you get `ok:false` and the charge for that call is refunded (total_calls / usage_log / ep_log are rolled back together). Only calls that actually returned data count.
Quotes (quote / kline / orderbook / changedist) are real-time or current session; financials, shareholders, dividends and events are within T+1 of upstream disclosure. The `source` field in every response tells you which data channel actually served it.
No. `code` is a single-value parameter — one stock per call. For batches, issue concurrent calls and respect your tier per-minute limit.
Set up MCP once, then just ask the AI — it calls the endpoint itself. MCP exposes 31 tools covering quotes, financials, screening, sectors and macro.
Set up MCP once, then just ask the AI — it calls the endpoint itself.