/xueqiu/quotes/search

POST /api/xueqiu/quotes/search

Price: 5 credits

Rank the securities of a market or board on Xueqiu (Shanghai, Shenzhen, ChiNext, Beijing, Hong Kong, US, US-listed Chinese companies) by change, price, volume, turnover, market capital, followers, P/E or dividend yield, with each security's quote, valuation and growth figures

How to use it

Xueqiu ranks at most 5000 securities per market; shanghai_shenzhen and us reach that limit. Pass a returned symbol to xueqiu/quotes for the live detail.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of securities to return (min: 1; max: 5000)
• market string required — Market or board to list (one of: "shanghai_shenzhen", "shanghai", "shenzhen", "chinext", "beijing", "hong_kong", "us", "us_china")
• sort_by string — Ranking field (default: "change_percent"; one of: "change_percent", "price", "volume", "amount", "market_capital", "turnover_rate", "followers_count", "pe_ttm", "dividend_yield")
• order string — Ranking direction (default: "desc"; one of: "desc", "asc")

Response

• @type string (default: "XueqiuScreenerQuote")
• symbol string required
• name string nullable
• url string nullable
• security_type string nullable
• price number nullable
• change number nullable
• change_percent number nullable
• change_percent_5m number nullable
• ytd_change_percent number nullable
• total_change_percent number nullable
• first_day_change_percent number nullable
• amplitude number nullable
• volume number nullable
• amount number nullable
• turnover_rate number nullable
• volume_ratio number nullable
• market_capital number nullable
• float_market_capital number nullable
• total_shares number nullable
• float_shares number nullable
• eps number nullable
• pe_ttm number nullable
• pb number nullable
• pb_ttm number nullable
• ps number nullable
• pcf number nullable
• roe_ttm number nullable
• dividend_yield number nullable
• income_cagr number nullable
• net_profit_cagr number nullable
• main_net_inflows number nullable
• northbound_net_inflow number nullable
• northbound_net_inflow_at integer nullable
• limit_up_days integer nullable
• followers_count integer nullable
• lot_size integer nullable
• tick_size number nullable
• dual_counter_symbol string nullable
• listed_date integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.