--- title: "EU consumer confidence (European Commission)" method: GET path: "/api/v1/eurostat/consumer-confidence" tags: ["Statistical Agencies"] --- # EU consumer confidence (European Commission) `GET /api/v1/eurostat/consumer-confidence` ## Request - Base URL: `https://sugra.ai` - URL: `https://sugra.ai/api/v1/eurostat/consumer-confidence` - Auth: API key in header `x-api-key` - TypeScript: (a function with typed inputs; its response is checked against the schema) The European Commission consumer confidence indicator, monthly, for the EU members, the euro area, the EU (EU27_2020) and the EU candidate countries, from the Commission's harmonised consumer survey as Eurostat publishes it (dataset ei_bsco_m). The value is a balance in percentage points: the share of consumers answering positively minus the share answering negatively, averaged over four questions on household finances, the general economic situation and major purchases, seasonally adjusted, so it runs from -100 to 100. Each row is dated by its survey month, not its release date. A month with no value is null, never zero, and `flag` marks provisional or estimated values. Data for other countries is not served. A non-empty answer is cached for a day. Processed by Sugra; every answer carries the credit Source: the Eurostat dataset DOI, the access date. ## Query parameters - `geo` string, nullable: Geography codes, comma separated: an EU member (DE, FR, EL for Greece), EA21 for the euro area, EU27_2020 for the EU, or a candidate country (AL, BA, GE, MD, ME, MK, RS, TR, UA). Other countries are refused: their data is not served. Omitted: every served geography. - `since` string, nullable: First survey month: 2024-01, or a year such as 2024 for its January. Omitted: the 36 months that end with `until`, or with the current month when `until` is omitted too. - `until` string, nullable: Last survey month: 2026-10, or a year such as 2026 for its December. ## Response `200` Monthly balances per geography, the unit, and the Eurostat credit. - EnvelopeEurostatSurveyData - `data` EurostatSurveyData, required - `dataset` string, nullable: The key of this series: consumer-confidence or economic-sentiment. - `title` string, nullable: Name of the series. - `description` string, nullable: What the indicator measures. - `eurostat_code` string, nullable: The Eurostat dataset code: ei_bsco_m or ei_bssi_m_r2. - `indicator` string, nullable: The Eurostat indicator code: BS-CSMCI or BS-ESI-I. - `producer` string, nullable: Who runs the survey: the European Commission (DG ECFIN). - `frequency` string, nullable: monthly. - `seasonal_adjustment` string, nullable: seasonally adjusted. - `unit` string, nullable: Unit of every value: balance, percentage points (consumer confidence) or index, long-term average = 100 (economic sentiment). - `unit_note` string, nullable: What the unit means. - `updated` string, nullable: When Eurostat last updated the dataset, as Eurostat states it. - `accessed` string, nullable: Date Sugra read the data from Eurostat, YYYY-MM-DD. - `latest_month` string, nullable: Newest survey month in this answer that carries a value. - `missing_geos` string[], nullable: Requested geography codes with no row in this answer. - `count` integer, nullable: Rows returned. - `data` EurostatSurveyRow[], nullable: Rows, by geography and then month, oldest first. - `geo` string, nullable: Eurostat geography code: an EU member (EL for Greece), EA21 for the euro area, EU27_2020 for the EU, or a candidate country. - `geo_label` string, nullable: The geography's name as Eurostat writes it. - `month` string, nullable: Survey month, YYYY-MM. Not the release date. - `value` union: The indicator value in the unit named by `unit`. Null where Eurostat publishes no value, never zero. - integer - number - `flag` string, nullable: Eurostat observation flag, null for a plain value: p provisional, e estimated, b break in series, and the other codes Eurostat defines. - `source` string, nullable: Eurostat. - `doi` string, nullable: The DOI of the Eurostat dataset. - `credit` string, nullable: Source: the dataset DOI, the access date; the producer, and that the data is 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. - `502`: The upstream source answered with an error or a malformed body. `detail` carries the source, the upstream status and a retry hint. - `503`: One of three. The upstream QUEUED this extraction instead of answering it (`UpstreamDeferredResponse`: typed `detail` object, `error: upstream_deferred`; the request was accepted and refused nothing, and `retry_hint` states how often and for how long to repeat it before reporting it instead). The upstream was unreachable (typed `detail` object, `error: upstream_unreachable`). Or the legacy blanket unavailability (string `detail`). - `504`: The upstream source did not answer within the client deadline. ## Changes > 74 revisions in range; 1 not diffed. - **2026-11-10** `b243ad417d29`: 1 info - endpoint added [Operation history](https://skmtc.dev/sugra/apis/sugra-api/changes/api/v1/eurostat/consumer-confidence/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/2867db71b7aa?raw)