/fedstat/indicators/data

POST /api/fedstat/indicators/data

Price: 20 credits

Get the observations of one EMISS indicator, sliced by year and by its own dimension values

How to use it

fedstat.ru has no server-side paging here: it hands over the whole cross-tabulation of whatever was selected, and a wide indicator crosses years, regions, months and classifiers into millions of cells. Years and filters cut the answer down far more than count does. Dimension ids and their value ids come from the indicator endpoint; labels and classifier codes work in place of ids, and anything else is rejected instead of being quietly dropped. Every dimension you leave out is taken in full.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• indicator_id integer required — EMISS indicator identifier (examples: 41003, 43230, 62731; min: 1)
• count integer required — Number of observations to return (min: 1)
• years array nullable — Keep only observations of these calendar years (examples: [2019,2020])
• filters object nullable — Slice by dimension: a mapping of dimension id to the value ids, Russian labels or classifier codes (such as an OKATO code) to keep (examples: {"33560":["1540283"],"40260":["СНГ"]})
  • * array

Response

• @type string (default: "FedstatObservation")
• cell_id string required
• indicator_id integer required
• year integer nullable
• period string (default: "")
• unit string (default: "")
• value number nullable
• value_text string (default: "")
• dimensions array (default: [])
  • @type string (default: "FedstatObservationDimension")
  • id string required
  • name string required
  • value_id string required
  • value string required
  • value_code string (default: "")

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 — Ran out of time: either fedstat.ru never began sending the indicator's page, which a few indicators do and some of them recover from on a later call, or the slice walk itself ran out, in which case whatever observations were already collected come back with it. 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 such indicator id, fedstat.ru serves it only to signed-in users, or it carries no observations. 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.