Skip to main content
Every Voltpath API response follows the same envelope shape: a meta object that describes provenance, time range, and resolution, plus a data array containing the endpoint-specific payload rows. Understanding this envelope helps you verify what the server resolved and how the data was produced.

​
The envelope

A typical response looks like this:
​
string
required
Whether the data is directly measured or computed:
  • measured - raw data from upstream sources such as ENTSO-E
  • derived - computed from other signals, such as flows calculated from prices and scheduled exchanges
​
string | null
The applied aggregation resolution. Examples: 1H, 1D, 1W, or null when native (raw) data is returned.
​
datetime | null
The UTC start datetime the server actually used after resolving relative shortcuts.
​
datetime | null
The UTC end datetime the server actually used after resolving relative shortcuts.
​
string[] | null
A list of upstream data sources, for example ["ENTSO-E Transparency Platform"].
​
array
The payload rows. The exact schema varies by endpoint.

​
Datetime parameters

You can specify time ranges using either absolute ISO 8601 datetimes or relative shorthand. Absolute format:
Relative shorthand:
  • now - current UTC time
  • now-30d - 30 days ago
  • now-7d - 7 days ago
  • now-1H - 1 hour ago
  • now-15m - 15 minutes ago
All datetimes are resolved to UTC. When you use relative shorthand, the exact boundaries depend on when the server processes the request. Always check resolved_datetime_from and resolved_datetime_to in the response meta to confirm the actual range used.

​
Resolution

The resolution query parameter controls how data is aggregated. Available options:
  • auto (default) - the server selects a resolution based on the width of the date range. Recommended for most use cases.
  • native - returns raw data regardless of range. Use with caution on wide date ranges, as responses can become very large.
  • 1H - hourly aggregation
  • 1D - daily aggregation
  • 1W - weekly aggregation
Resolution is not available on /api/v1/flow-duration and /api/v1/zone-import-export.

​
Interpolated flag

Some rows include an interpolated or flow_interpolated boolean. When this flag is true, the value was estimated to fill a gap in the upstream data rather than directly observed.
  • PriceRow: interpolated indicates a gap-filled price
  • FlowTypeRow: flow_interpolated indicates a gap-filled flow
When building analytics or trading models, consider treating interpolated values with appropriate caution, since they are modeled rather than measured.

​
Error responses

When query parameters fail validation, the API returns a 422 Validation Error with a standard error body.

​
Example 422 response

The detail array contains one or more error objects with the following fields:
​
array
required
The location of the invalid input, typically ["query", "<parameter_name>"].
​
string
required
A human-readable description of what went wrong.
​
string
required
The error type classification, for example enum for invalid enum values.