/tuik/datasets

POST /api/tuik/datasets

Price: 20 credits

Get observations of one TÜİK dataset, sliced by dimension codes and period

How to use it

The numbers behind a TÜİK statistic, once you know its dataflow code. A cell is addressed by its dimensions, never by row order. A null value is not missing data when is_confidential is true — the figure is suppressed for statistical confidentiality. One dataflow holds the whole published history at every frequency it covers, so pass since, until or a FREQ filter unless you want it all.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• dataset string required — Dataflow code exactly as the catalogue publishes it, version suffix included (examples: "DF_ALTINSIZ_IHRACAT_BDE+V1.0", "DF_ADNKS_T18+V1.1"; minLength: 1)
• count integer required — Number of observations to return (min: 1)
• filters object nullable — Keep only cells whose dimension takes one of the listed codes, keyed by the dimension code returned in dimensions[].concept (examples: {"FREQ":["A"],"REF_AREA":["TR"]})
  • * array
• since string nullable — Drop periods ending before this date, as YYYY, YYYY-MM or YYYY-MM-DD (examples: "2020")
• until string nullable — Drop periods starting after this date, as YYYY, YYYY-MM or YYYY-MM-DD (examples: "2024")
• lang string — Language of dimension names and value labels (default: "tr"; one of: "tr", "en")

Response

• @type string (default: "TuikObservation")
• key string required
• dataset string required
• dataset_name string nullable
• period string required
• period_label string nullable
• period_start string nullable
• period_end string nullable
• value number nullable
• is_confidential boolean (default: false)
• dimensions array (default: [])
  • @type string (default: "TuikCodeValue")
  • concept string required
  • name string nullable
  • code string required
  • label string nullable
• attributes array (default: [])
  • @type string (default: "TuikCodeValue")
  • concept string required
  • name string nullable
  • code string required
  • label string nullable

Errors

• 422 — filters names a concept that is not a dimension of this dataflow, a value code that dimension does not take, or a concept in the attribute role, which qualifies a cell rather than addressing it 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 — Dataflow code not found, catalogued without published observations, or the requested slice holds no cells 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.