Pro endpoint · Pro

Factor screening API

Screen the whole market with a factor expression, e.g. intersect([PE_TTM > 0, PE_TTM < 20, ROETTM > 15]).

ProGET /v1/screen
Signature
GET /v1/screen?expr=intersect(%5BPE_TTM%20%3E%200%2C%20PE_TTM%20%3C%2020%2C%20ROETTM%20%3E%2015%5D)
One-liner
curl "https://api.ashareapi.com/v1/screen?expr=intersect(%5BPE_TTM%20%3E%200%2C%20PE_TTM%20%3C%2020%2C%20ROETTM%20%3E%2015%5D)&key=YOUR_KEY"
Parameters: expr · preset · limit · orderby · desc · market* = required

Quick start

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

curl
# 注：expr 的值已做 URL 编码（含 [ ] 空格 等）
# 推荐：Authorization 头（密钥不进日志）
curl -H "Authorization: Bearer YOUR_KEY" \
  "https://api.ashareapi.com/v1/screen?expr=intersect(%5BPE_TTM%20%3E%200%2C%20PE_TTM%20%3C%2020%2C%20ROETTM%20%3E%2015%5D)"

# 快速测试：直接浏览器打开（?key= 会留在日志/历史里，别用于生产）
curl "https://api.ashareapi.com/v1/screen?expr=intersect(%5BPE_TTM%20%3E%200%2C%20PE_TTM%20%3C%2020%2C%20ROETTM%20%3E%2015%5D)&key=YOUR_KEY"
Python
import requests

r = requests.get(
    "https://api.ashareapi.com/v1/screen",
    headers={"Authorization": "Bearer YOUR_KEY"},
    params={},
    timeout=30,
)
print(r.json())
JavaScript
const r = await fetch("https://api.ashareapi.com/v1/screen?expr=intersect(%5BPE_TTM%20%3E%200%2C%20PE_TTM%20%3C%2020%2C%20ROETTM%20%3E%2015%5D)", {
  headers: { Authorization: "Bearer YOUR_KEY" },
});
console.log(await r.json());

Parameters

exprstring
Factor expression, e.g. intersect([PE_TTM > 0, PE_TTM < 20, ROETTM > 15])
presetstring
Preset name (alternative to expr): LowPE / LowPB / HighDividend / PEG / HighROE, and 17 more
limitinteger
Number of rows, default 30
orderbystring
Sort field (e.g. ROETTM)
descboolean
True = descending, False = ascending
marketstring
Market: hs (A-share) / hk / us (blank = A-share)

Response example

Sample: `GET /v1/screen?expr=intersect([PE_TTM > 0, PE_TTM < 20, ROETTM > 15])&limit=3` (real response, 2026-09-26, truncated). ⚠️ Note `data` is a Markdown table string, not an array — read `structured` or `tables` from code.

{
  "ok": true,
  "endpoint": "screen",
  "tier": "unlimited",
  "elapsed_ms": 2430,
  "source": "multi",
  "data": "| code | name | PE_TTM | ROETTM | ClosePrice | ChangePCT |\n| --- | --- | --- | --- | --- | --- |\n| sz000656 | 金科股份 | 0.35 | 883.0546 | 1.23 | -2.38 |\n| … |",
  "structured": [
    { "code": "sz000656", "name": "金科股份", "PE_TTM": "0.35",
      "ROETTM": "883.0546", "ClosePrice": "1.23", "ChangePCT": "-2.38" },
    { "code": "sh600841", "name": "动力新科", "PE_TTM": "2.40",
      "ROETTM": "50.3702", "ClosePrice": "5.63", "ChangePCT": "-1.57" }
  ],
  "tables": [ [ /* same content as structured, as a table array */ ] ]
}
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; solve one PoW challenge for 60/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

Why is `data` a Markdown table string?

So you can paste the result straight into an LLM. `data` is Markdown table text; for code, read the sibling `structured` (array of objects) or `tables` (array of tables) — all three carry identical content.

How do I write a screening expression?

Combine conditions with `intersect([...])`, e.g. `intersect([PE_TTM > 0, PE_TTM < 20, ROETTM > 15])`. You can also use a `preset` such as `LowPE`. `limit` defaults to 20. The returned columns are determined by the factors you put in `expr`.

Is `/v1/screen` free? Is there a free alternative?

It is a paid endpoint. A call without a key returns `{"error":"需要 API Key（此端点属付费层）"}`. Free alternatives: `/v1/changedist` (advance/decline distribution), `/v1/hot` (hot list) and `/v1/market-overview`.

Which columns come back?

Whatever your expression asks for — factors in `expr` become the returned columns. For the sample expression: `code` / `name` / `PE_TTM` / `ROETTM` / `ClosePrice` / `ChangePCT`.

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 60/min regardless of type.

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 24 tools covering quotes, financials, screening, sectors and macro.

Related endpoints

Financial statementsMoney flow + boards + marginTechnical indicatorsShareholder researchChip distribution / cost五档盘口（order book · 买五卖五）全字段行情画像（估值/市值/股本/涨停价）Stock event labels (42)

Upstream & downstream endpoints

Up/down distributionHot listMarket overview
Use it from an AI Agent?

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

MCP setupPricing

← Back to the full endpoint reference