githubEdit

API Endpoints

Access power generation forecast data through the Jua Query Engine.

Available Endpoints

1. Get Available Zones

GET /v1/power-forecast/zones

Returns list of available zone keys (countries/regions).

Example:

curl -X GET "https://query.jua.ai/v1/power-forecast/zones" \
  -H "X-API-Key: your_api_key_id:your_api_secret"

Response:

{"zones": ["DE"]}

2. Get Available PSR Types

GET /v1/power-forecast/psr-types

Returns list of available power system resource types.

Example:

curl -X GET "https://query.jua.ai/v1/power-forecast/psr-types" \
  -H "X-API-Key: your_api_key_id:your_api_secret"

Response:


3. Get Available Init Times

Returns recent forecast initialization times for a zone.

Query Parameters:

  • zone_key (required): Zone identifier (e.g., "DE")

  • limit (optional): Number of recent init times to return

Example:

Response:

Fields:

  • init_time: Forecast initialization timestamp (ISO 8601)

  • max_prediction_timedelta: Maximum forecast horizon in minutes


4. Get Forecast Data

Retrieve power forecast data for specified zones and PSR types.

Request Body:

Request Parameters:

Parameter
Type
Required
Description

zone_keys

array[string]

Yes

List of zone identifiers

psr_types

array[string]

Yes

List of PSR types ("Solar", "Wind Onshore")

latest_init_time

boolean

No

Get latest forecast (default: false)

init_times

array[string]

No

Specific init times to query

order_by

array[string]

No

Sort order (e.g., ["time"], ["init_time", "time"])

Note: Use either latest_init_time: true OR provide specific init_times, not both.

Example - Latest Forecast:

Example - Specific Init Times:

Response Format:

Response Fields:

  • zone_key: Array of zone identifiers (repeated for each data point)

  • psr_type: Array of PSR types (repeated for each data point)

  • init_time: Array of forecast initialization times

  • time: Array of forecast valid times (15-minute intervals)

  • value: Array of power values in MW

Notes:

  • All timestamps are in UTC with timezone offset (+00:00)

  • Power values are in MW (Megawatts)

  • Time resolution is 15 minutes

  • Each forecast run typically covers until the end of the next day


Python Example


Error Responses

401 Unauthorized

400 Bad Request


See Also

Last updated