Query

Felder

availableSeries(…): AvailableSeries!

Lists the series available in the catalog, optionally restricted to a section of the catalog tree.

Always returns a result; a filter that matches nothing yields an empty listing rather than null.

Argumente

prefix: String

Restricts the result to series whose id starts with this string.

The comparison is a plain, case-sensitive prefix match on the raw id and is not aligned to path segment boundaries: de.sv matches de.sv.allgemein.bezugsgroesse, and so would de.s.

If omitted or null, all series of the catalog are returned.

series(…): Series

Returns the metadata of a single series, or null if the catalog contains no series with this id.

This query describes the series itself; use dataPoint to read the values it holds at a point in time.

Argumente

seriesId: ID!

The full id of the series, matched exactly, for example de.sv.allgemein.bezugsgroesse.

dataPoint(…): DataPoint

Resolves the values of a series for a given point on both time axes.

A series can carry several related values, and they are always resolved together: one query for the reference value of German social insurance returns both the annual and the monthly amount. See DataPoint.

Among the data points of the series, all candidates with validFrom <= validOn and knownFrom <= knownOn are considered. The highest validFrom among them determines the validity interval in force on validOn; within that interval, the candidate with the highest knownFrom — the latest known state of that interval — is returned.

Returns null if the series is unknown, or if no data point satisfies both constraints — typically because validOn predates the coverage of the series (coveredFrom), or because knownOn predates the day on which the value was first published in the catalog.

Note that a null result is not an error: it is the correct answer to a question about a point in time for which no value was in force or known.

Argumente

seriesId: ID!

The full id of the series, matched exactly, for example de.sv.allgemein.bezugsgroesse.

validOn: LocalDate

The date at which the value is to apply as a matter of law.

If omitted or null, the current date of the server is used, which yields the value in force today. Pass an explicit date whenever the answer must stay reproducible.

knownOn: LocalDate

The state of knowledge to answer from: the catalog is treated as it stood on this date, so corrections published later are ignored.

If omitted or null, the current date of the server is used, which yields the latest state of knowledge. Pass an explicit date to reproduce a past run, and note that the answer to the same query can change over time as long as this argument is left out.

value(…): Decimal

Resolves a single value part of a series for a given point on both time axes, for example the monthly reference value of German social insurance.

A shorthand for dataPoint when only the number is needed: the data point is selected by exactly the same rules, and the result is the value of its entry in DataPoint.values whose key equals valuePartKey. The unit is not returned; read it from Series.valueParts. Use dataPoint whenever the answer must be traceable, since only it reports validFrom, knownFrom and the legal sources of the value.

Returns null if the series is unknown, if no data point satisfies both constraints, or if the selected data point carries no value under valuePartKey. As with dataPoint, a null result is not an error.

Argumente

seriesId: ID!

The full id of the series, matched exactly, for example de.sv.allgemein.bezugsgroesse.

valuePartKey: String!

The key of the value part, matched exactly, for example jahr or monat; one of the keys listed in Series.valueParts.

validOn: LocalDate

The date at which the value is to apply as a matter of law.

If omitted or null, the current date of the server is used, which yields the value in force today. Pass an explicit date whenever the answer must stay reproducible.

knownOn: LocalDate

The state of knowledge to answer from: the catalog is treated as it stood on this date, so corrections published later are ignored.

If omitted or null, the current date of the server is used, which yields the latest state of knowledge. Pass an explicit date to reproduce a past run, and note that the answer to the same query can change over time as long as this argument is left out.

serverInfo: ServerInfo!

Returns information about the server answering this request.

Intended for diagnostics and support, not for business logic: the result describes the deployment, not the catalog.