/nbs_china/indicators/search

POST /api/nbs_china/indicators/search

Price: 5 credits

Search NBS China indicators by name or free text; each hit carries its latest published value

How to use it

Hits come from the annual databases, each one indicator with its latest value: national indicators by default, provincial or city ones when the query names a province or city. Reach monthly, quarterly and international series through nbs_china/indicators/tree. Feed leaf_id and dataset into nbs_china/indicators/data for the full series. A query matching nothing still returns a few loosely related hits.

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 search hits (min: 1)
• query string required — Indicator name or free text in Chinese (examples: "居民消费价格指数", "2024年 北京 GDP"; minLength: 1)

Response

• @type string (default: "NbsChinaSearchHit")
• indicator_id string required
• indicator_name string required
• short_name string nullable
• description string nullable
• leaf_id string required
• path_ids array (default: [])
• dataset string nullable (one of: "national_monthly", "national_quarterly", "national_annual", "province_monthly", "province_quarterly", "province_annual", "city_monthly", "city_annual", "major_economies_monthly", "commodity_prices_monthly", "countries_annual", "hong_kong_annual", "macao_annual", "taiwan_annual")
• dataset_name string nullable
• region_code string nullable
• region_name string nullable
• period string nullable
• period_name string nullable
• period_start integer nullable
• value number nullable
• value_text string 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.