Free endpoint · Free

Health check API

Checks service status and whether both data CLIs are ready.

FreeGET /v1/health
Signature
GET /v1/health
One-liner
curl "https://api.ashareapi.com/v1/health"
Parameters: none* = required

Quick start

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

curl
# 免费端点：无需 API Key（匿名即可调用）
curl "https://api.ashareapi.com/v1/health"
Python
import requests

r = requests.get(
    "https://api.ashareapi.com/v1/health",
    params={},
    timeout=30,
)
print(r.json())
JavaScript
const r = await fetch("https://api.ashareapi.com/v1/health");
console.log(await r.json());

Response example

Sample: `GET /v1/health` (real response, 2026-09-26). ⚠️ This is the only endpoint that returns no `data` field — it also has no `endpoint` / `tier` / `elapsed_ms` / `source`.

{
  "ok": true,
  "uptime_s": 2532,
  "data_ready": true,
  "tiers": ["free", "trial", "standard", "pro", "unlimited"]
}
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

Does the health check count against my quota?

No. `/v1/health` is not counted in usage and does not consume the anonymous rate limit (6 rapid calls all returned 200). Safe to use as a probe.

What does `data_ready: false` mean?

It means the data channels are currently unavailable — data endpoints may then return `ok:false`. It reflects the readiness of our upstream data channels and does not mean the HTTP service is down (it still responds normally with this field).

What are `uptime_s` and `tiers`?

`uptime_s` = seconds the service process has been running; `tiers` = the list of supported tiers (free / trial / standard / pro / unlimited).

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

获取 PoW 挑战（匿名提额用）Real-time quoteK-line (D/W/M)Hot listMarket overviewUp/down distribution

Upstream & downstream endpoints

Usage & quota
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