Order book (five best bids / asks) API
Second-level snapshot of the five best bids and asks — price and resting volume (in lots) for b1–b5 and a1–a5, plus last price, change and data time. Field naming follows the Tushare convention and is flat (df["b1_p"] works directly): b1_p/b1_v … b5_p/b5_v = bid price/volume, a1_p/a1_v … a5_p/a5_v = ask price/volume. Use it to read seal strength, buy/sell pressure and intraday support/resistance. ⚠️ Only meaningful during the session (after the close it is the day's final snapshot); data refreshes about every 10 seconds. ⚠️ Volume is in lots (×100 = shares); all bid levels read 0 at limit-down and all ask levels read 0 at limit-up (normal).
GET /v1/orderbookGET /v1/orderbook?code=sh600667curl "https://api.ashareapi.com/v1/orderbook?code=sh600667&key=YOUR_KEY"code ** = requiredQuick start
Replace the key below with yours (free endpoints need no key):
# 推荐:Authorization 头(密钥不进日志)
curl -H "Authorization: Bearer YOUR_KEY" \
"https://api.ashareapi.com/v1/orderbook?code=sh600667"
# 快速测试:直接浏览器打开(?key= 会留在日志/历史里,别用于生产)
curl "https://api.ashareapi.com/v1/orderbook?code=sh600667&key=YOUR_KEY"import requests
r = requests.get(
"https://api.ashareapi.com/v1/orderbook",
headers={"Authorization": "Bearer YOUR_KEY"},
params={"code": "sh600667"},
timeout=30,
)
print(r.json())const r = await fetch("https://api.ashareapi.com/v1/orderbook?code=sh600667", {
headers: { Authorization: "Bearer YOUR_KEY" },
});
console.log(await r.json());Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | Yes | Stock code with market prefix: sh600667 (SH), sz000001 (SZ), hk00700 (HK), usAAPL (US) |
codestringYesResponse fields
The table below is captured from real API calls (not inferred): each row gives the field name, its type and one real sample value, so you can align your parser.
dataEnvelope: ok / endpoint / tier / elapsed_ms / sourceProbed: 2026-10-20| Field | Type | Real sample value |
|---|---|---|
| code | str | sh600519 |
| name | str | 贵州茅台 |
| price | num | 1331.88 |
| prev_close | num | 1324.97 |
| open | num | 1321.01 |
| high | num | 1335 |
| low | num | 1316.14 |
| change | num | 6.91 |
| change_pct | num | 0.52 |
| time | str | 20261020150601 |
| b1_p | num | 0 |
| b1_v | num | 0 |
| a1_p | num | 1331.88 |
| a1_v | num | 10 |
| b2_p | num | 0 |
| b2_v | num | 0 |
| a2_p | num | 0 |
| a2_v | num | 0 |
| b3_p | num | 0 |
| b3_v | num | 0 |
| a3_p | num | 0 |
| a3_v | num | 0 |
| b4_p | num | 0 |
| b4_v | num | 0 |
| a4_p | num | 0 |
| a4_v | num | 0 |
| b5_p | num | 0 |
| b5_v | num | 0 |
| a5_p | num | 0 |
| a5_v | num | 0 |
Unified 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 <your key>. ⚠️ The anonymous allowance is tiered by caller type: browsers (humans) get 5/min; scripts, SDKs and AI Agents (curl, requests, axios, openai user-agent strings) get 2/min — automated traffic is easier to abuse. Solving one PoW challenge (GET /v1/challenge, then send the X-PoW header) raises it to 15/min regardless of type. ⚠️ Also, anonymous calls are capped at 250 bars per request and 100k rows per day — use an API key for the full 1212 bars or unlimited daily volume.
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 source disclosure. Every response carries its own data timestamp — time (HHMM) on intraday bars, date (trading day) on quotes — so you can check exactly which moment a payload reflects.
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 92 tools covering quotes, financials, screening, sectors and macro.
Related endpoints
Set up MCP once, then just ask the AI — it calls the endpoint itself.