Skip to content
Documentation

Find time series

GET /repositories/{repository}/timeSeries

Returns all time series that match the given parameters.

Name In Type Required Description
repository path string yes The repository in which to look for time series.
attribute query string[] no Query parameter for filtering time series by assigned attributes.

Supports the following variants:
- ?attribute=<name>
- ?attribute=<name>|<value>
- ?attribute=oneof(<name1>,<name2>)
- ?attribute=oneof(<name1>|<value1>,<name2>|<value2>)
- ?attribute=<name1>|oneof(<value1>,<value2>)

A <datetimeexpression> restriction can be attached to any <value>, oneof(<name1>|<value1>,<name2>|<value2>) or <name1>|oneof(<value1>,<value2>) expression to limit the search time-frame:
Time series will be looked for that have an attribute with the specified name and value within the target time-frame.
If attached to a oneof(...) expression it is applied to all values within the expression unless overwritten by a <datetimeexpression> directly attached to a <value> within the oneof(...) expression.
The <datetimeexpression> can have one of the following forms:
- @<datetime> (the expression is applied at the exact date and time of <datetime>)
- @from:<datetime> (the expression is applied at or any date and time after <datetime>)
- @to:<datetime> (the expression is applied at or any date and time before <datetime>)
- @from:<datetime1>to:<datetime2> (the expression is applied between <datetime1> and <datetime2>)

You may specify multiple attribute parameters in the query string; all conditions must be met (logical AND).

Wildcards are supported in <name> and <value>. Wildcards allow matching multiple attribute names or values:
- ? matches any single character
- * matches any sequence of characters

Examples:
- ?attribute=Type
- ?attribute=Type|Solar
- ?attribute=Type|Coal
- ?attribute=Type|Coal@2026-02-10T16:08:27.9359993+01:00 (finds time series with an assigned Type attribute having the value Coal at exactly 2026-02-10T16:08:27.9359993+01:00)
- ?attribute=Type|Coal@from:2026-02-10T16:08:27.9359993+01:00 (finds time series with an assigned Type attribute having the value Coal at or any time after 2026-02-10T16:08:27.9359993+01:00)
- ?attribute=Type|Coal@to:2026-02-10T16:08:27.9359993+01:00 (finds time series with an assigned Type attribute having the value Coal at or any time before 2026-02-10T16:08:27.9359993+01:00)
- ?attribute=Type|Coal@from:2020-02-10T16:08:27.9359993+01:00to:2026-02-10T16:08:27.9359993+01:00 (finds time series with an assigned Type attribute having the value Coal at any time between 2020-02-10T16:08:27.9359993+01:00 and 2026-02-10T16:08:27.9359993+01:00 (both thresholds are inclusive))
- ?attribute=Location|DE
- ?attribute=Location|DE&attribute=Type|Solar
- ?attribute=Active|true
- ?attribute=Type|oneof(Solar,Wind,Coal) (matches Type attribute with any of the values Solar, Wind, or Coal)
- ?attribute=Type|oneof(Solar,Wind,Coal)@2026-02-10T16:08:27.9359993+01:00 (finds time series with an assigned Type attribute having the value Solar, Wind or Coal at exactly 2026-02-10T16:08:27.9359993+01:00)
- ?attribute=Type|oneof(Solar@from:2026-02-10T16:08:27.9359993+01:00,Wind@to:2026-02-10T16:08:27.9359993+01:00,Coal)@2026-02-10T16:08:27.9359993+01:00 (finds time series with an assigned Type attribute having either: the value Solar at or after 2026-02-10T16:08:27.9359993+01:00, Wind up to 2026-02-10T16:08:27.9359993+01:00 or Coal exactly at 2026-02-10T16:08:27.9359993+01:00)
- ?attribute=Location|oneof(DE,AT) (matches Location attribute with either DE or AT)
- ?attribute=Type|Solar&attribute=Active|true (matches time series where Type is Solar AND Active is true)
- ?attribute=Type|S* (matches all Type values starting with ‘S’, e.g. Solar, Steam)
- ?attribute=Location|D? (matches all Location values starting with ‘D’ and followed by any single character, e.g. DE, DK)
- ?attribute=T*|Solar (matches all attribute names starting with ‘T’ and value ‘Solar’, e.g. Type|Solar, Tag|Solar)
- ?attribute=Type|oneof(Solar,Wind)&attribute=Active|true (matches time series where Type is Solar or Wind AND Active is true)
- ?attribute=oneof(Type|Solar,Location|DE) (matches time series where Type is Solar OR Location is DE)

When multiple filters are given, individual filters are connected using a logical AND, so attribute=<filterA>&attribute=<filterB> returns only those time series whose attributes match both <filterA> and <filterB>.
changedSince query string (date-time) no Restricts the search to time series whose definition, attribute assignments, attribute data or time series assignments were last changed at or after this point in time; writing time series data does not count as a change. The comparison uses the resolution of the repository’s time base. A modification that fails part-way or changes nothing may also be counted.

Accepts an ISO 8601 date and time with Z or an offset, e.g. 2024-05-01T10:15:30Z or 2024-05-01T12:15:30+02:00. In a raw query string, send the + of an offset percent-encoded as %2B, because an unencoded + is read as a space. A value without an offset is read in the server’s local time zone.
cyclic query boolean no Whether to look for cyclic time series or non-cyclic time series.
description query string no Description of the time series
formula query string no Formula of the time series
function query integer (int32) | string no Function type of the time series
include query string[] no Related data to load together with each time series.

May be repeated (?include=attributes&include=attributeUnits) or comma separated (?include=attributes,attributeUnits).

- attributes - the attributes assigned to the time series and their values.
- attributeUnits - the list attribute unit of each assignment, including its name. Implies attributes.
- listAttributeValues - the list attribute values the data of each list attribute assignment uses, as a usedValues object keyed by the raw value (verbatim, whatever the casing) whose values have the shape of GET /repositories/{repository}/lists/units/{unit}/values, or are null when the effective unit (the unit of the assignment, else the only unit of its attribute, else the default unit of an attribute with several units) does not list the value or there is none. Implies attributes, but not attributeUnits. Enum: attributes, attributeUnits, listAttributeValues
interval.multiplier query integer (int32) no Interval multiplier of the time series
interval.type query integer (int32) | string no Interval type of the time series
intervalTransformationMethod query integer (int32) | string no Interval transformation method of the time series
name query string no Name of the time series
order query string[] no Specifies one or more orderings for the results.

The value should consist of the property by which to order and the direction separated by a comma.
If no direction is specified, it defaults to unspecified and may depend on where exactly the results are retrieved from.

Available properties to order by:
* name
* function
* cyclic
* description
* intervalTransformationMethod
* startOfTime
* unit
* interval.type
* interval.multiplier Enum: name, name,unspecified, name,ascending, name,descending, function, function,unspecified, function,ascending, function,descending, cyclic, cyclic,unspecified, cyclic,ascending, cyclic,descending, description, description,unspecified, description,ascending, description,descending, intervalTransformationMethod, intervalTransformationMethod,unspecified, intervalTransformationMethod,ascending, intervalTransformationMethod,descending, startOfTime, startOfTime,unspecified, startOfTime,ascending, startOfTime,descending, unit, unit,unspecified, unit,ascending, unit,descending, interval.type, interval.type,unspecified, interval.type,ascending, interval.type,descending, interval.multiplier, interval.multiplier,unspecified, interval.multiplier,ascending, interval.multiplier,descending
startOfTime query string (date-time) no Start of time of the time series
timeZone query string no Time zone of the time series
unit query string no Unit of the time series
functionType query number no Deprecated. OBSOLETE! Use parameter function instead! Function type of the time series to find.
includeAttributes query boolean no Deprecated. Do not use!

Please use the include parameter instead.

Decides if the results should contain the assigned attributes and their related data. Equivalent to include=attributes.
intervalMultiplier query integer (int32) no Deprecated. Obsolete! Please use the interval.multiplier parameter instead. Interval multiplier of the time series
intervalType query number no Deprecated. Obsolete! Please use the interval.type parameter instead! Interval type of the time series
Range header string (timeSeries=0-99) no Specifies the range that should be returned.
Format: timeSeries=[<range-start>]-[<range-end>]

Example values:
* Retrieve the first eleven items: timeSeries=-10
* Retrieve items number 6 through 11: timeSeries=5-10
* Retrieve all items starting at the fourth: timeSeries=3-
* Retrieve the first item: timeSeries=0-0

Note that the first example behaves slightly different from the specification. Not specifying a range-start is the same as specifying 0 as the start of the range.
For performance reasons, there is currently no method for retrieving the last n items of the result.

In addition, multiple ranges for the same unit in one requests are currently not supported.
Code Description Type
200 Successfully found one or more time series. (SuccessOfResolvedTimeSeriesReferenceOfInt32 | Failure)[]
206 Successfully found one or more time series within the requested range. no body
404 Indicates that the given repository does not exist. ProblemDetails
416 Indicates that the request failed due to an invalid range request being made. Make sure the ‘Range’ header is correct. ProblemDetails
4XX Indicates that the request failed due to a client error. Please refer to the details provided in the body of the response in order to ensure that the request can be handled properly. ProblemDetails
5XX Indicates that the request failed due to an error that occurred on the server. Consider reporting this error to the server operators. ProblemDetails

Headers

Header Type Description
Accept-Ranges string Lists the units for which ranges may be specified.
[
{
"$successful": true,
"value": {
"storageInformation": {
"repositoryName": "string"
},
"identifier": 0,
"value": {
"name": "string",
"description": "string",
"function": 2,
"cyclic": true,
"interval": {
"type": 2,
"multiplier": 0
},
"unit": {
"storageInformation": {},
"identifier": "string"
},
"intervalTransformationMethod": 1,
"formula": {
"2020-01-01T00:00:00Z": "Its a formula!"
},
"timeZone": "Europe/Vienna",
"startOfTime": "2026-01-01T00:00:00Z",
"preserveDuplicatedValues": true,
"preserveHistoricData": true,
"preserveAuditLog": true,
"quotation": true,
"quotationDefaultBehavior": 2,
"compressionMode": 1,
"compressionMultiplier": 0
}
}
}
]

Headers

Header Type Description
Accept-Ranges string Lists the units for which ranges may be specified.
Content-Range string If a ‘Range’ header was specified, this header will return the range returned. Please note that there are some issues with open ranges as well as when data is streamed asynchronously from a repository, since the total number of results is not always known when this header is set. Therefore, the content of this header can - at the present - not be used reliably for determining the total number of items available.

Schema: ProblemDetails

{
"type": "?",
"title": "HK09008",
"status": 400,
"detail": "A description of the problem",
"instance": "https://..",
"root": {
"type": "?",
"title": "HK15019",
"status": 500,
"detail": "An error occurred while performing the requested operation...",
"instance": "https://.."
},
"roots": [
{
"type": "?",
"title": "HK15019",
"status": 500,
"detail": "An error occurred while performing the requested operation...",
"instance": "https://.."
},
{
"type": "?",
"title": "HK15019",
"status": 500,
"detail": "An error occurred while performing the requested operation...",
"instance": "https://.."
}
],
"traceId": "dd71e2e0-c77a-4608-b1d7-fcb9353b9a35"
}

Headers

Header Type Description
Accept-Ranges string Lists the units for which ranges may be specified.

Schema: ProblemDetails

{
"type": "?",
"title": "HK09008",
"status": 400,
"detail": "A description of the problem",
"instance": "https://..",
"root": {
"type": "?",
"title": "HK15019",
"status": 500,
"detail": "An error occurred while performing the requested operation...",
"instance": "https://.."
},
"roots": [
{
"type": "?",
"title": "HK15019",
"status": 500,
"detail": "An error occurred while performing the requested operation...",
"instance": "https://.."
},
{
"type": "?",
"title": "HK15019",
"status": 500,
"detail": "An error occurred while performing the requested operation...",
"instance": "https://.."
}
],
"traceId": "dd71e2e0-c77a-4608-b1d7-fcb9353b9a35"
}

Schema: ProblemDetails

{
"type": "?",
"title": "HK09008",
"status": 400,
"detail": "A description of the problem",
"instance": "https://..",
"root": {
"type": "?",
"title": "HK15019",
"status": 500,
"detail": "An error occurred while performing the requested operation...",
"instance": "https://.."
},
"roots": [
{
"type": "?",
"title": "HK15019",
"status": 500,
"detail": "An error occurred while performing the requested operation...",
"instance": "https://.."
},
{
"type": "?",
"title": "HK15019",
"status": 500,
"detail": "An error occurred while performing the requested operation...",
"instance": "https://.."
}
],
"traceId": "dd71e2e0-c77a-4608-b1d7-fcb9353b9a35"
}

Schema: ProblemDetails

{
"type": "?",
"title": "HK09008",
"status": 400,
"detail": "A description of the problem",
"instance": "https://..",
"root": {
"type": "?",
"title": "HK15019",
"status": 500,
"detail": "An error occurred while performing the requested operation...",
"instance": "https://.."
},
"roots": [
{
"type": "?",
"title": "HK15019",
"status": 500,
"detail": "An error occurred while performing the requested operation...",
"instance": "https://.."
},
{
"type": "?",
"title": "HK15019",
"status": 500,
"detail": "An error occurred while performing the requested operation...",
"instance": "https://.."
}
],
"traceId": "dd71e2e0-c77a-4608-b1d7-fcb9353b9a35"
}
© 2026 Volue.Version v0.6.38017 November 2026