--- title: "Statistics Denmark consumer confidence series" method: GET path: "/api/v1/statistical-agencies/dst-confidence/series" tags: ["Statistical Agencies"] --- # Statistics Denmark consumer confidence series `GET /api/v1/statistical-agencies/dst-confidence/series` ## Request - Base URL: `https://sugra.ai` - URL: `https://sugra.ai/api/v1/statistical-agencies/dst-confidence/series` - Auth: API key in header `x-api-key` - TypeScript: (a function with typed inputs; its response is checked against the schema) Statistics Denmark consumer confidence for Denmark, monthly since 1974-10, in balance points, not seasonally adjusted: the consumer confidence indicator F1 and the twelve survey questions F2 to F13. Live from StatBank table FORV1 (no key needed upstream), cached for a day. A month without a figure ('..' or '.') is absent from the series, never zero; an indicator the table carries no figure for is listed in missing_indicators and in meta.notes. Source: Statistics Denmark, StatBank.dk/FORV1 (CC BY 4.0), processed by Sugra; not unchanged official statistics. ## Query parameters - `indicator` string, nullable: FORV1 indicator code: F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13. Omit for all thirteen. - `start_period` string, nullable: First month: 2020 or 2020-01. - `end_period` string, nullable: Last month: 2026 or 2026-10. ## Response `200` One series per indicator in balance points. - EnvelopeDstConfidenceData - `data` DstConfidenceData, required - `table` string, nullable: StatBank table: FORV1. - `area` string, nullable: DK. - `area_name` string, nullable: Denmark. - `frequency` string, nullable: M. - `unit` string, nullable: Unit of every value in this answer: balance points. - `seasonally_adjusted` boolean, nullable: False. - `latest_period` string, nullable: Newest month with a figure in the table. - `count` union: Observations across the series returned. - integer - number - `series` DstConfidenceSeries[], nullable: One series per indicator. - `indicator` string, nullable: FORV1 indicator code. - `name` string, nullable: Statistics Denmark's English text for the code. - `group` string, nullable: headline or question. - `unit` string, nullable: Unit of the values: balance points. - `frequency` string, nullable: M. - `seasonally_adjusted` boolean, nullable: False. - `first_period` string, nullable: First month with a figure, of the full series. - `last_period` string, nullable: Last month with a figure, of the full series. - `no_value_months` union: Months of this indicator for which Statistics Denmark gives no figure ('..' or '.'); absent from data, never zero. - integer - number - `count` union: Observations returned in the window. - integer - number - `data` CbsConfidenceDatum[], nullable: Observations, oldest first. - `period` string, nullable: Survey month, YYYY-MM. - `value` union: Balance points. - integer - number - `missing_indicators` string[], nullable: Indicators Sugra labels that the table carries no figure for (empty normally). - `unlabelled_indicators` string[], nullable: Indicators the table carries that Sugra has no label for; not served (empty normally). - `no_value_months` union: Cells of the known indicators with no figure ('..' or '.'), all indicators, left out. - integer - number - `source` string, nullable: Credit: Statistics Denmark. - `license` string, nullable: CC BY 4.0. - `attribution` string, nullable: Source: Statistics Denmark, StatBank.dk/FORV1 (CC BY 4.0). - `modified_notice` string, nullable: The processing note: the data was processed by Sugra. - `meta` SugraMeta, required: Metadata on a /api/v1/* response envelope built through `helpers.response.sugra_response`, which is how routes are expected to answer. A route that assembles its own `meta` dict carries only the keys it writes itself, so an optional field below can be absent because this response has nothing to report OR because that route does not build its envelope here - the two are not distinguishable from the outside. - `endpoint` string, required: Requested endpoint path. - `data_time` string, required: ISO 8601 timestamp the data on this response is stamped with. It is the source's own timestamp whenever the source supplied one this API could read; when it did not, this field falls back to the value of `response_time` and `data_age_days` is omitted, so the PRESENCE of that field is the signal to read - with the one exception named in its own description, a route that substitutes its own current time for a source timestamp it never received. Usually UTC (`Z`), but a source stating its own numeric offset keeps it (2026-04-16T14:30:00+09:00) rather than being converted a second time. For a source that publishes by period this is the period's START (see `period`) and for one that publishes by calendar day it is that day's midnight - in neither case a moment at which anything was observed or released. - `response_time` string, required: ISO 8601 UTC timestamp when this response was produced. - `provider` string, required: API name and version. - `data_age_days` number, nullable: Age of the data in days at the moment this response was produced, i.e. `response_time` minus `data_time`. Present ONLY when the timestamp this response is stamped with is a clock time that could be read as a real instant. It is ABSENT - never 0 - in every other case. Absent when no readable source timestamp was supplied, because `data_time` then repeats `response_time` and a zero age would assert that the data is current precisely where its true age is unknown. Absent when the source names a calendar day, a month, a quarter or a year (see `period`): the instant is then a boundary this API anchored at midnight, and time since a day or a quarter BEGAN is a different quantity from the age of the data - a daily series is out by up to a day, a quarterly one by up to a quarter. A midnight counts as such a boundary whichever zone it is stated in, and whether the source stated it or this API anchored it. The one case this field cannot see is a route that substitutes its own current time for a source timestamp it never received: the substituted value is a real, readable instant and is indistinguishable from one the source stated, so the age reads as roughly 0. The shared cache-and-fetch helper behind most routes stopped doing that, but the presence of this field is a statement about the timestamp the response carries, not a guarantee about the route that supplied it. Rounded to 0.001 day (86.4 seconds), so 0.0 is a real measured age anywhere within roughly +/-43 seconds and not a stand-in for unknown; a source stamping an instant in the future reports a negative value (-0.001 or less) rather than being clamped. Sources publish on very different cadences, so a non-zero age is normal, not an error. Preserve absence in client code: a generated client that materialises a missing optional number as its numeric default turns 'age unknown' back into 'age zero', which is the exact confusion this field exists to remove. - `source` string, nullable: Identifier of the primary upstream source used for this response. - `attribution` string, nullable: Human-readable attribution mandated by an upstream source (e.g. a securities regulator or self-regulatory organization). Present only on responses whose source requires the owner and source to be clearly identified. Do not remove or alter it when using the response. - `source_url` string, nullable: The publisher's own public page for the data this response answers, so a person or an agent can open the same data at the source. Present only on responses from the official publishers that have such a page for the exact data asked: FRED, SEC EDGAR, the European Central Bank, the U.S. Treasury, GLEIF and the World Bank. Absent where no such page exists (a search, a catalog or a multi-series batch) and on every other source. For the European Central Bank it is the page of the dataflow the series belong to. - `citation` string, nullable: A ready citation line that can be pasted as is: the publisher, the dataset or series title when the route has it with its identifier, the `source_url` page and the date this response was produced. Present exactly when `source_url` is. It does not replace `attribution`, which carries a notice a source requires and must be kept as sent. - `fallback_used` boolean, nullable: True when the primary source failed and a fallback produced the data. - `fallback_chain` string[], nullable: Ordered list of sources attempted, in the order they were tried. - `cached` boolean, nullable: True when this response was served from the internal cache. - `stale` boolean, nullable: True when the response is known stale under its source freshness policy, or when a cached response was returned after the upstream rate-limited or errored. Clients can use this to detect degraded data. - `stale_since` string, nullable: ISO 8601 UTC timestamp of the last good copy this response was served from. Present only when stale is true. - `period` string, nullable: Unit of observation, when the source publishes by period rather than by instant. `data_time` carries the period's START instant so it stays machine-readable; this field preserves what that instant used to mean, which the conversion would otherwise erase. Present only for such sources, and only when the source hands the API the label itself - a client that converts the period to its start instant before building the envelope loses the label, though not the age exclusion, which is decided by the instant. Note that `data_age_days` is omitted whenever this is present, because an age measured from a period start is not a freshness figure. - `notes` string, nullable: Data-quality caveat about THIS response - how old the underlying report is, a chokepoint AIS lower-bound, or that a source-reported `data_time` could not be read and the response time is shown instead. Distinct from `attribution`, which is a licensing obligation. Multiple caveats are joined with ' | '. Present only when there is one. ## Other responses - `401`: Missing or invalid `x-api-key` header. JSON body with a stable `code` distinguishing `missing_api_key` (no header sent) from `invalid_api_key` (header sent, key not accepted); any other 401 source carries the generic `unauthorized` with its detail as `reason`. Plus `hint`. `plan` is always null on 401 - an unauthenticated request has no plan; quota exhaustion is 429, not 401. - `422`: Validation Error - `429`: Daily rate limit exceeded. Check `X-RateLimit-Reset` for the next window. - `500`: This API answered a shape its own schema refuses. Typed body `error: response_shape_invalid`. Stays a 500. Not an upstream failure. - `503`: Upstream source is temporarily unavailable. Retry after a short delay. `detail` is text, or the typed object with source and retry hint when the source is unreachable. ## Changes > 67 revisions in range; 1 not diffed. - **2026-11-06** `4e0c4c347d30`: 1 info - endpoint added [Operation history](https://skmtc.dev/sugra/apis/sugra-api/changes/api/v1/statistical-agencies/dst-confidence/series/get.md) --- [API](https://skmtc.dev/sugra/apis/sugra-api.md) - [All operations](https://skmtc.dev/sugra/apis/sugra-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sugra/apis/sugra-api/revisions/dbcf5e4b0b13?raw)