Pro endpoint · Pro

Natural-language Q&A with inline citations (BYOK — bring your own model key) API

Q: Do these endpoints need an API key?

Free endpoints do not: health, challenge, quote, kline, hot, market-overview and changedist work anonymously. Paid endpoints do: send Authorization: Bearer . ⚠️ 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.

Q: Am I charged when the upstream returns nothing or errors?

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.

Q: How fresh is the data?

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.

Q: Can I request several stocks in one call?

No. code is a single-value parameter — one stock per call. For batches, issue concurrent calls and respect your tier per-minute limit.

⭐ Ready-to-use Q&A: we fetch the data and generate an answer with inline citations — no orchestration on your side. How it differs from /v1/agent-search: that one returns "structured candidates + evidence" only and generates no answer; this one builds an answer on top of it. 🔑 BYOK (bring your own model key), passed in request headers: X-LLM-Provider (deepseek / openai / moonshot) · X-LLM-Key (your model key) · X-LLM-Model (optional, pin a model). ⚠️ How we handle your key: used only in memory for this single request — never stored, never logged. ⚠️ Paid tier — Standard (¥29.9) and above.

ProPOST /v1/agent-ask

Signature

POST /v1/agent-ask?q=%E5%A4%AA%E6%9E%81%E5%AE%9E%E4%B8%9A&scope=

One-liner

curl "https://api.ashareapi.com/v1/agent-ask?q=%E5%A4%AA%E6%9E%81%E5%AE%9E%E4%B8%9A&scope=&key=YOUR_KEY"

Parameters: q * · scope · max_results · recency* = required

Quick start

Replace the key below with yours (free endpoints need no key):

curl

# 注：q 的值已做 URL 编码（含 [ ] 空格 等）
# 推荐：Authorization 头（密钥不进日志）
curl -H "Authorization: Bearer YOUR_KEY" \
  "https://api.ashareapi.com/v1/agent-ask?q=%E5%A4%AA%E6%9E%81%E5%AE%9E%E4%B8%9A&scope="

# 快速测试：直接浏览器打开（?key= 会留在日志/历史里，别用于生产）
curl "https://api.ashareapi.com/v1/agent-ask?q=%E5%A4%AA%E6%9E%81%E5%AE%9E%E4%B8%9A&scope=&key=YOUR_KEY"

Python

import requests

r = requests.get(
    "https://api.ashareapi.com/v1/agent-ask",
    headers={"Authorization": "Bearer YOUR_KEY"},
    params={"q": "太极实业"},
    timeout=30,
)
print(r.json())

JavaScript

const r = await fetch("https://api.ashareapi.com/v1/agent-ask?q=%E5%A4%AA%E6%9E%81%E5%AE%9E%E4%B8%9A&scope=", {
  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
scope	string	No	Data-source scope (optional): ashare (our own data) / notice,news,report (filings & news) / web (open-web search, needs X-LLM-Key) / wechat (WeChat Official Accounts). Blank = auto-select by the question.
max_results	integer	No	Maximum number of result rows (default 10, max 50).
recency	string	No	Time window, e.g. 7d / 24h (optional). Out-of-window items are still returned but marked unverified.

qstringYes

Keyword: a stock name (Chinese works) or a code

scopestring

Data-source scope (optional): ashare (our own data) / notice,news,report (filings & news) / web (open-web search, needs X-LLM-Key) / wechat (WeChat Official Accounts). Blank = auto-select by the question.

max_resultsinteger

Maximum number of result rows (default 10, max 50).

recencystring

Time window, e.g. 7d / 24h (optional). Out-of-window items are still returned but marked unverified.

Response 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.

Located in: dataEnvelope: ok / endpoint / tier / elapsed_ms / source / degradedProbed: 2026-10-20

Field	Type	Real sample value
id	str	ref_1
source_endpoint	str	/quote
params		—
field_path	str	data[0].last
value	str	227.90
value_hash	str	b5d3bf596061dad3
as_of	str	2026-10-21

Response

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.

Rate limits & quota

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)

Do these endpoints need an API key?

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.

Am I charged when the upstream returns nothing or errors?

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.

How fresh is the data?

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.

Can I request several stocks in one call?

No. code is a single-value parameter — one stock per call. For batches, issue concurrent calls and respect your tier per-minute limit.

How do I use this from Claude / Cursor / ChatGPT?

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

Natural-language search with evidence chain (for your own orchestration)Async research task (submit · cited report · BYOK)Full-history K-line (10y daily · raw + adjustment factors)Whole-market single-day K-line (all A-shares, 5,000+ in one call)Quant backtest (single-stock live / portfolio precomputed)Quant strategy list (20 single-stock + 9 portfolio, with measured performance)IP allow-list (lock a key to fixed IPs)Batch backtest (many stocks × many strategies)

Use it from an AI Agent?

Set up MCP once, then just ask the AI — it calls the endpoint itself.

MCP setup Pricing

← Back to the full endpoint reference