Skip to content

Next-24h forecast with leak-free hindcast for a region

GET
/api/v1/platforms/{platform}/regions/{region}/forecast

Authorizations

or
session

Browser session cookie.

Type
API Key (cookie: bp_session)
or
apiKey

User API key: Authorization: Bearer bpi_...

Type
HTTP (bearer)

Parameters

Path Parameters

platform*
Type
string
Required
Valid values
"Windows""EGS""GRDK"
region*
Type
string
Required

Responses

OK

application/json
JSON
{
  
"$schema": "https://bpincentives.com/schemas/ForecastBody.json",
  
"actual": [
  
],
  
"confidence": "string",
  
"generatedAt": 0,
  
"horizonHours": 0,
  
"past": [
  
],
  
"platform": "string",
  
"points": [
  
],
  
"region": "string"
}

Playground

Variables
Key
Value

Samples

Powered by VitePress OpenAPI