Instantly calculate energy cost
Ingests a meter record and instantly returns import or export monetary value (cost) of energy.
- If you are metering a device, submit records using
device_id
parameter. - If you are metering a location (i.e. main supply address meter), submit records under
location_id
parameter.
Authorizations
Authenticate with bearer_token
you obtained from /login endpoint.
Query Parameters
Indicates direction you want to work with. Set to IMPORT
, EXPORT
or LOCAL
. Defaults to IMPORT
.
Set to true
if you want to include tariff data.
Set to true
if you want to include carbon intensity data.
Body
FlatPeak location_id
that you are submitting metering records for.
FlatPeak device_id
you are submitting metering records for. If you provided both location_id
and device_id
your records will be attributed to device_id
.
A reference for a group of metering records, for example, a charging session ID.
A reference for this metering record, for example, meter log ID.
Indicates metering direction. Set to IMPORT
, EXPORT
or LOCAL
. Defaults to IMPORT
. LOCAL direction is in beta. Contact support to enable.
Possible options are OFFERED
or TRANSFERRED
. Currently only TRANSFERRED
is supported.
Units of measure, supported values are W, KW, WH, KWH. When W or KW units are submitted, cost will be calculated using the constant power rate over the period.
Amount of energy measured.
Estimated confidence of data where '1' is 100% accurate and 0.1 is 10% accurate. Defaults to '1'. This parameter is in beta. Contact support to enable.
Metering record start time. In RFC3339 format e.g. 2023-06-15T09:00:00Z
or with time-offset, e.g. 2023-06-15T08:00:00+01:00
.
Metering record end time. In RFC3339 format e.g. 2023-06-15T09:00:00Z
or with time-offset, e.g. 2023-06-15T08:00:00+01:00
.
Response
FlatPeak meter record id.
FlatPeak object type, i.e. meter_record
.
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Indicates energy direction. Supported values are IMPORT and EXPORT.
Currency code for cost of energy measure.
Units of energy measure.
Units of carbon emissions measure.
Value of energy object
Time when this object was created. In UTC.
FlatPeak account ID.
Was this page helpful?