Stock Screener (scanner Agent): natural-language conditions - + citations + tool trace (BYOK) API
把自然语言条件交给选股员（scanner Agent），返回候选池、引用与工具轨迹。 ⚠️ BYOK：必须带 X-LLM-Key（模型 Key），以及本服务的 API Key；模型 token 由客户自己付。 ⚠️ 能力额度独立：99 专业版 2,000 次（生命周期）/ 199 机构版 10,000 次/月，不占数据 API 的 500k 总池。 ⚠️ 只有 ok:true 且返回非空选股结果才扣次数；失败/空结果退回。 ⚠️ 不构成投资建议；不自动交易。
GET /v1/scannerGET /v1/scanner?q=%E5%A4%AA%E6%9E%81%E5%AE%9E%E4%B8%9Acurl "https://api.ashareapi.com/v1/scanner?q=%E5%A4%AA%E6%9E%81%E5%AE%9E%E4%B8%9A&key=YOUR_KEY"q ** = requiredQuick start
Replace the key below with yours (free endpoints need no key):
# 注：q 的值已做 URL 编码（含 [ ] 空格 等）
# 推荐：Authorization 头（密钥不进日志）
curl -H "Authorization: Bearer YOUR_KEY" \
"https://api.ashareapi.com/v1/scanner?q=%E5%A4%AA%E6%9E%81%E5%AE%9E%E4%B8%9A"
# 快速测试：直接浏览器打开（?key= 会留在日志/历史里，别用于生产）
curl "https://api.ashareapi.com/v1/scanner?q=%E5%A4%AA%E6%9E%81%E5%AE%9E%E4%B8%9A&key=YOUR_KEY"import requests
r = requests.get(
"https://api.ashareapi.com/v1/scanner",
headers={"Authorization": "Bearer YOUR_KEY"},
params={"q": "太极实业"},
timeout=30,
)
print(r.json())const r = await fetch("https://api.ashareapi.com/v1/scanner?q=%E5%A4%AA%E6%9E%81%E5%AE%9E%E4%B8%9A", {
headers: { Authorization: "Bearer YOUR_KEY" },
});
console.log(await r.json());Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| q | string | Yes | Keyword: a stock name (Chinese works) or a code |
qstringYesResponse 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-31| Field | Type | Real sample value |
|---|---|---|
| answer | str | 命中 20 行 |
| citations | list | [ref_1] |
| interpreted | dict | {"capability":"scanner"} |
| meta | dict | {"n_rows":20} |
| quota | dict | {"included":2000,"used":1} |
| quota_charged | bool | true |
| snapshot_id | str | scn_... |
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 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 39 tools covering quotes, financials, screening, sectors and macro.
Related endpoints
Set up MCP once, then just ask the AI — it calls the endpoint itself.