Sign in

v1

latestOpenAPI 3.1.02026-07-1342111193.6 KB
Spark

Calculate Smart Charging Schedule

Provided details around charging duration and a prospective charging window, returns a charging schedule that minimizes costs for a particular UtilityAccount.

post/spark/charge_curve/schedule

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Request body

utility_account_idinteger

(Beta - due to limited coverage) The unique ID of the utility account that this calculation is being run against. Either a utility_account_id or main_tariff_id is required for a valid request.

main_tariff_idstring

The Genability 'masterTariffId' unique identifier for this tariff. See Genability documentation for details. Either a utility_account_id or main_tariff_id is required for a valid request.

start_timestring date-time required

ISO8601 timestamp of when the charge begins. Note that the timestamp will be rounded down to the start of latest charge block resolution. For example, if the charge_block_resolution is 1h and the charging session starts at 2021-06-24T14:59:59Z, the start_time used to calculate the curve's cost will be normalized to 2021-06-24T14:00:00Z. If the charge_block_resolution is 15m, the start_time would be normalized to 2021-06-24T14:45:00Z. This rounding technique eliminates ambiguity around charging that occurs across time-of-use on/mid/off-peak window boundaries.

end_timestring date-time required

ISO8601 datetime by which the charge must be complete.

minutes_to_charge_completeinteger required

The number of minutes of charging required to complete a charge.

charge_block_resolution'5m' | '10m' | '15m' | '30m' | '1h'

The duration of the charge blocks to use in the returned charge_block_active param.

Example request

{
  "main_tariff_id": "gen_mtid_3331108",
  "start_time": "2021-03-18T22:00:00-07:00",
  "end_time": "2021-03-19T08:00:00-07:00",
  "minutes_to_charge_complete": 330
}

Response

Success

start_timestring date-time required
charge_block_resolution'5m' | '10m' | '15m' | '30m' | '1h' required

The duration of the charge blocks returned in the charge_block_active array.

Example response

{
  "start_time": "2021-03-18T22:00:00-07:00",
  "charge_block_resolution": "1h",
  "charge_block_active": {
    "frequency": "1h"
  }
}