POST
/
costs
/
instant

Authorizations

Authorization
string
headerrequired

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
location_id
string
required

FlatPeak location_id that you are submitting metering records for.

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.

session_reference_id
string

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

record_reference_id
string

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

direction
string

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

tariff_rate
string

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

measurand
string

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

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.

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.

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.

Response

200 - application/json
id
string
required

FlatPeak meter record id.

object
string
required

FlatPeak object type, i.e. meter_record.

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.

direction
string
required

Indicates energy direction. Possible values are IMPORT or EXPORT.

tariff_rate
string
required

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

currency_code
string
required

Currency code for cost of energy measure.

energy_units
string
required

Units of energy measure.

carbon_units
string
required

Units of carbon emissions measure.

request
object
required
data
object
required

Value of energy object

time_created
string
required

Time when this object was created. In UTC.

account_id
string

FlatPeak account ID.

Was this page helpful?

Check batch statusBy time interval