Pro endpoint · Pro

Quant playbook library (how to judge the market · 13 playbooks) API

A library of playbooks — reusable "how to judge the market" workflows. Each one spells out its signals (formula + data + threshold), its stages (e.g. sentiment: freeze / start / ferment / climax / ebb, with the action for each), what losses it avoids, and the measured evidence behind it (backtest numbers; entries marked "pending" have not been run — we do not invent figures). Covers 13 playbooks across 12 themes: risk control · trend/momentum · fundamentals · valuation percentile · portfolio rebalancing · money flow · market timing · sector rotation · sentiment cycle · volume structure · event-driven · limit-up chasing · ST restructuring. ⚠️ Playbooks are a judgement process, not investment advice — thresholds are adjustable starting points. Past backtests do not indicate future results. ⚠️ Static list (no heavy quota). Paid tier — Pro (¥99) and above.

ProGET /v1/playbooks
Signature
GET /v1/playbooks?category=
One-liner
curl "https://api.ashareapi.com/v1/playbooks?category=&key=YOUR_KEY"
Parameters: category · id* = required

Quick start

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

curl
# 推荐:Authorization 头(密钥不进日志)
curl -H "Authorization: Bearer YOUR_KEY" \
  "https://api.ashareapi.com/v1/playbooks?category="

# 快速测试:直接浏览器打开(?key= 会留在日志/历史里,别用于生产)
curl "https://api.ashareapi.com/v1/playbooks?category=&key=YOUR_KEY"
Python
import requests

r = requests.get(
    "https://api.ashareapi.com/v1/playbooks",
    headers={"Authorization": "Bearer YOUR_KEY"},
    params={},
    timeout=30,
)
print(r.json())
JavaScript
const r = await fetch("https://api.ashareapi.com/v1/playbooks?category=", {
  headers: { Authorization: "Bearer YOUR_KEY" },
});
console.log(await r.json());

Parameters

categorystring
Filter by theme (e.g. 情绪周期 / 风险管理)
idstring
Fetch one playbook by id (e.g. sentiment-cycle)
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 `. ⚠️ 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 26 tools covering quotes, financials, screening, sectors and macro.

Use it from an AI Agent?

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

← Back to the full endpoint reference