/bse/quotes/search

POST /api/bse/quotes/search

Price: 1 credit

Rank the stocks traded on the Beijing Stock Exchange by volume, amount, change, price or code: latest price, previous close, open, high, low, change, volume, amount, P/E and the five-level order book of each

How to use it

Volumes are in shares and money in CNY. For one stock's intraday line use bse/companies/quotes.

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 quotes to return (min: 1; max: 400)
• sort string — Field to rank by (default: "volume"; one of: "volume", "amount", "change_percent", "price", "code")
• direction string — Ranking direction (default: "desc"; one of: "desc", "asc")
• stock_code string nullable — Six-digit stock code to match (examples: "920021"; pattern: ^\d{6}$)

Response

• @type string (default: "BseQuote")
• company_code string required
• name string nullable
• price_cny number nullable
• previous_close_cny number nullable
• open_cny number nullable
• high_cny number nullable
• low_cny number nullable
• change_cny number nullable
• change_percent number nullable
• volume_shares integer nullable
• amount_cny number nullable
• pe_ratio number nullable
• trade_date integer nullable
• quoted_at integer nullable
• currency string nullable
• transfer_mode string nullable
• bids array (default: [])
  • @type string (default: "BseOrderLevel")
  • price_cny number nullable
  • volume_shares integer nullable
• asks array (default: [])
  • @type string (default: "BseOrderLevel")
  • price_cny number nullable
  • volume_shares integer nullable
• intraday array (default: [])
  • @type string (default: "BseIntradayPoint")
  • time string required
  • price_cny number nullable
  • high_cny number nullable
  • low_cny number nullable
  • cumulative_volume_shares integer nullable
  • cumulative_amount_cny number nullable

Errors

• 422 — stock_code is not six digits, or an unknown sort or direction 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.