Skip to main content
POST
/
costs
/
instant
Submit interval meter records and instantly calculate energy cost
curl --request POST \
  --url https://api.flatpeak.com/costs/instant \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "location_id": "loc_641b90b758fb8e6293716e40",
  "energy_flow_direction": "INBOUND",
  "enegy_kwh": 1.657,
  "start_time": "2022-02-01T10:30:00Z",
  "end_time": "2022-02-01T11:00:00Z",
  "device_id": "dev_65e6d8334c8d715963d99db3",
  "session_reference_id": "SESSION1234567890",
  "record_reference_id": "MET1234567890"
}
'
{
  "account_id": "acc_661677911f2197045e6cf1b1",
  "id": "ecs_65ea3fb185c1541f247c251e",
  "object": "energy_cost",
  "object_id": "dev_65e6d8334c8d715963d99db3",
  "live_mode": true,
  "location_timezone": "Europe/London",
  "currency_code": "EUR",
  "data": [
    {
      "start_time": "2022-02-01T10:30:00Z",
      "end_time": "2022-02-01T11:00:00Z",
      "cost": {
        "value": 928.372,
        "confidence": 1
      },
      "session_reference_id": "SESSION1234567890",
      "record_reference_id": "MET1234567890",
      "energy_kwh": 14.7
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Authenticate with bearer you obtained from authentication endpoint.

Query Parameters

​
non_persistent
boolean

Set to true to avoid storing metering records permanently. Use for simulating consumption to estimate potential energy costs.

Body

application/json
​
location_id
string
required

Flatpeak location_id that you are submitting metering records for.

Example:

"loc_641b90b758fb8e6293716e40"

​
energy_flow_direction
string
required

Energy flow direction. Set to INBOUND or OUTBOUND. Defaults to INBOUND.

Example:

"INBOUND"

​
enegy_kwh
number
required

Energy transferred in kilowatt hours. Negative numbers represent export.

Example:

1.657

​
start_time
string<date-time>
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.

Example:

"2022-02-01T10:30:00Z"

​
end_time
string<date-time>
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.

Example:

"2022-02-01T11:00:00Z"

​
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.

Example:

"dev_65e6d8334c8d715963d99db3"

​
session_reference_id
string

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

Example:

"SESSION1234567890"

​
record_reference_id
string

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

Example:

"MET1234567890"

Response

​
account_id
string
required

Flatpeak account id.

Example:

"acc_661677911f2197045e6cf1b1"

​
id
string

Flatpeak unique object ID that represents this response.

Example:

"ecs_65ea3fb185c1541f247c251e"

​
object
string

Flatpeak object type. I.e. energy_cost.

Example:

"energy_cost"

​
object_id
string

Flatpeak object location_id or device_id cost data is for.

Example:

"dev_65e6d8334c8d715963d99db3"

​
live_mode
boolean

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

​
location_timezone
string

The timezone at the location, in 'tz database format'. I.e. 'Europe/Berlin'.

Example:

"Europe/London"

​
currency_code
string

Currency code for cost of energy measure. Always returned in large currency units.

Example:

"EUR"

​
data
object[]