Forecast Data
Get the calculated forecast for a forecast variable, ignoring forecast events
Changed onGetting the calculated forecast for the given forecast variable. The range between these two dates can not exceed 120 days. Forecast events are NOT taken into consideration.
get/v2/forecasts/forecast-variables/{externalForecastVariableId}/calculated-forecast
Request
- Base URLhttps://api.quinyx.com
- AuthOAuth 2Client credentialsToken URL/oauth/tokenScopesforecast:read
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
externalForecastVariableIdstring required
Query parameters
externalUnitIdstring required
externalSectionIdstring
startTimestring date-time required
endTimestring date-time required
Response
OK
Example response
[
{
"externalForecastConfigurationId": "config-1",
"externalUnitId": "unit-1",
"externalSectionId": "section-1",
"dataPayLoad": [
{
"data": 100,
"editedData": 105,
"startTime": "2026-01-15T12:00:00Z",
"endTime": "2026-01-15T13:00:00Z"
}
],
"dataPayload": [
{
"data": 100,
"editedData": 105,
"startTime": "2026-01-15T12:00:00Z",
"endTime": "2026-01-15T13:00:00Z"
}
]
}
]Changes
- info
the endpoint scheme security
OAuth2ClientCredentialswas added to the API
- info