/sse/indices

POST /api/sse/indices

Price: 20 credits

List the indices published by the Shanghai Stock Exchange (SSE Composite, SSE 50, STAR 50, sector, theme, strategy, bond and other families), or get one by code: Chinese and English names and descriptions, family, base date and point, launch date, constituent count, methodology links and the codes of its total-return and net-return variants

How to use it

Pass `index_code` to sse/indices/constituents for the member stocks of an equity index.

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 indices to return (min: 1; max: 1000)
• index_code string nullable — Index code (examples: "000016", "000001"; pattern: ^[0-9A-Z]{6}$)
• category string nullable — Index family (one of: "size", "sector", "style", "theme", "strategy", "bond", "fund", "other", "customized", "dividend_point")

Response

• @type string (default: "SseIndex")
• index_code string required
• name string nullable
• name_en string nullable
• full_name string nullable
• full_name_en string nullable
• category string nullable
• category_en string nullable
• category_code integer nullable
• description string nullable
• description_en string nullable
• base_date integer nullable
• base_point number nullable
• launch_date integer nullable
• updated_date integer nullable
• constituents_count integer nullable
• is_price_index boolean nullable
• is_total_return_index boolean nullable
• is_net_return_index boolean nullable
• release_channel integer nullable
• methodology_url string nullable
• methodology_url_en string nullable
• total_return_index_code string nullable
• total_return_index_name string nullable
• total_return_index_name_en string nullable
• total_return_index_full_name string nullable
• total_return_index_full_name_en string nullable
• net_return_index_code string nullable
• net_return_index_name string nullable
• net_return_index_name_en string nullable
• net_return_index_full_name string nullable
• net_return_index_full_name_en string nullable

Errors

• 422 — index_code is not a six-character code, or an unknown category 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 — No SSE index under that index_code 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.