/fedstat/indicators/search

POST /api/fedstat/indicators/search

Price: 20 credits

Search the EMISS indicator catalogue by text and by agency, subject, state programme and coverage

How to use it

Start here to turn a subject into an indicator id. Query terms are Russian and several words narrow the result, but fedstat.ru also matches an indicator's classifier values, so a hit whose name looks unrelated is normal. Ids for organization_ids, theme_ids and gov_program_ids come from the entries this endpoint returns, and an id fedstat.ru does not publish is rejected rather than ignored. An entry flagged unapproved cannot be opened afterwards, and neither can an excluded entry that carried data; an excluded entry whose has_data is false still opens, passport only.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string nullable — Text matched by fedstat.ru against indicator names and classifier values; omit it to walk the whole catalogue (examples: "экспорт", "пшеница", "экспорт технологий"; minLength: 1)
• count integer required — Number of indicators to return (min: 1)
• organization_ids array nullable — Keep only indicators published by these agencies (examples: ["43","1"])
• theme_ids array nullable — Keep only indicators carrying one of these subject tags; -1 means untagged
• gov_program_ids array nullable — Keep only indicators attached to one of these state programmes; -1 means unattached
• covers_from_year integer nullable — Keep only series that start no later than this year (examples: 2015; min: 1900; max: 2100)
• covers_to_year integer nullable — Keep only series that end no earlier than this year (examples: 2024; min: 1900; max: 2100)
• is_excluded boolean nullable — Keep only indicators retired from the statistical register, or only current ones
• is_unapproved boolean nullable — Keep only indicators the agency has suspended, or only the ones it still serves
• is_form_based boolean nullable — Keep only indicators collected through a statistical form, or only computed ones
• has_data boolean nullable — Keep only indicators that carry observations, or only the empty ones

Response

• @type string (default: "FedstatCatalogueEntry")
• id integer required
• url string required
• name string required
• organization string (default: "")
• organization_id string (default: "")
• source string (default: "")
• is_form_based boolean (default: false)
• themes array (default: [])
• theme_ids array (default: [])
• gov_programs array (default: [])
• gov_program_ids array (default: [])
• data_start_year integer nullable
• data_end_year integer nullable
• has_data boolean (default: false)
• is_excluded boolean (default: false)
• is_unapproved boolean (default: false)

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.