Skip to main content
API docs by Redocly

Spark.SmartCharging.Api (1.0)

Download OpenAPI specification:Download

Actual

GetSpotPrices

Returns spot prices as set by Nord Pool.

Authorizations:
Bearer
path Parameters
priceArea
required
string
query Parameters
Currency
string (Currency)
Enum: "EUR" "NOK" "SEK" "DKK"
EnergyUnit
string (EnergyUnit)
Enum: "kWh" "MWh"
VATRate
number <double>
TimeZone
string
Default: "Europe/Amsterdam"

Responses

Response samples

Content type
application/json
{
  • "priceArea": "string",
  • "priceUnits": {
    },
  • "prices": {
    }
}

GetSpotPricesAdvice

Returns spot prices as set by Nord Pool, including price and cost advice depending on user, partner and/or overridden configuration parameters.

Authorizations:
Bearer
path Parameters
priceArea
required
string
Request Body schema: application/json
object (PriceUnitsParameters)
object (ChargingSessionParameters)
object (TimeZoneParameters)
startFrom
string or null <date-time>

Responses

Request samples

Content type
application/json
{
  • "priceUnitsParameters": {
    },
  • "chargingSessionParameters": {
    },
  • "timeZoneParameters": {
    },
  • "startFrom": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "advice": [
    ],
  • "spotPrices": [
    ],
  • "priceArea": "string",
  • "priceUnits": {
    },
  • "chargingSession": {
    }
}

Forecast

GetForecast

Returns price forecast for the next seven days in blocks of at least 3 hours. The block size can be any multiple of 24 and defaults to 6. Uses actual spot price data from Nord Pool where available.

Authorizations:
Bearer
path Parameters
priceArea
required
string
query Parameters
Currency
string (Currency)
Enum: "EUR" "NOK" "SEK" "DKK"
EnergyUnit
string (EnergyUnit)
Enum: "kWh" "MWh"
VATRate
number <double>
SegmentSize
integer <int32>
Default: 6
TimeZone
string
Default: "Europe/Amsterdam"

Responses

Response samples

Content type
application/json
{
  • "priceArea": "string",
  • "priceUnits": {
    },
  • "segmentOptions": {
    },
  • "forecastSegments": [
    ]
}

GetPriceForecastWithAdvice

Returns price forecast for the next seven days in blocks og at least 3 hours, including price and cost advice depending on user, partner and/or overridden configuration parameters. The block size can be any multiple of 24 and defaults to 6. Uses actual spot price data from Nord Pool where available.

Authorizations:
Bearer
path Parameters
priceArea
required
string
Request Body schema: application/json
object (PriceUnitsParameters)
object (SegmentOptionsParameters)
object (TimeZoneParameters)

Responses

Request samples

Content type
application/json
{
  • "priceUnitsParameters": {
    },
  • "segmentOptionsParameters": {
    },
  • "timeZoneParameters": {
    }
}

Response samples

Content type
application/json
{
  • "priceArea": "string",
  • "priceUnits": {
    },
  • "segmentOptions": {
    },
  • "forecastAdvice": [
    ]
}