Calculate Smart Charging Schedule

post

https://api.arcadia.com/spark/charge_curve/schedule

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

utility_account_id

integer

(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_id

string

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_time

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_time

date-time

required

ISO8601 datetime by which the charge must be complete.

minutes_to_charge_complete

integer

required

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

charge_block_resolution

string

enum

Defaults to 1h

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

Allowed:

Headers

Arcadia-Version

string

required

Defaults to 2022-10-13

The Arcadia-Version for the request

Responses

200Success

400Bad Request

404Not Found

422Unprocessable Entity