Instantly calculate energy cost

Authorizations

Authorization

string

header

required

Authenticate with bearer_token you obtained from /login endpoint.

Query Parameters

include_tariff

boolean

Set to true if you want to include tariff data.

include_carbon

boolean

Set to true if you want to include carbon intensity data.

Body

application/json

end_time

string

required

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.

location_id

string

required

FlatPeak location_id that you are submitting metering records for.

start_time

string

required

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.

units

string

required

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.

value

number

required

Amount of energy measured.

confidence

number

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.

device_id

string

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.

direction

string

Indicates metering direction. Set to IMPORT or EXPORT. Defaults to IMPORT.

measurand

string

Possible values are OFFERED or TRANSFERRED. Currently only TRANSFERRED is supported.

record_reference_id

string

A reference for this metering record, for example, meter log ID.

session_reference_id

string

A reference for a group of metering records, for example, a charging session ID.

tariff_rate

string

Indicates tariff direction. Set to IMPORT, EXPORT or LOCAL. Defaults to match the direction parameter.

Response

200 - application/json

carbon_units

string

required

Units of carbon emissions measure.

currency_code

string

required

Currency code for cost of energy measure.

data

object

required

Value of energy object

direction

string

required

Indicates energy direction. Possible values are IMPORT or EXPORT.

energy_units

string

required

Units of energy measure.

string

required

FlatPeak meter record id.

live_mode

boolean

required

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

object

string

required

FlatPeak object type, i.e. meter_record.

request

object

required

tariff_rate

string

required

Indicates tariff rate direction applied. Possible values are IMPORT, EXPORT or LOCAL.

time_created

string

required

Time when this object was created. In UTC.

account_id

string

FlatPeak account ID.