POST
/
costs
/
interval
/
{id}
curl --request POST \
  --url https://api.flatpeak.com/costs/interval/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "start_time": "2023-11-07T05:31:56Z",
  "end_time": "2023-12-07T05:31:56Z"
}'
{
  "id": "ecs_65ea3fb185c1541f247c251e",
  "object": "energy_cost",
  "object_id": "dev_65e6d8334c8d715963d99db3",
  "live_mode": true,
  "direction": "IMPORT",
  "location_timezone": "Europe/London",
  "currency_code": "EUR",
  "energy_units": "WH",
  "carbon_units": "gCO2eq",
  "data": [
    {
      "start_time": "2022-02-01T10:30:00Z",
      "end_time": "2022-02-01T11:00:00Z",
      "session_reference_id": "SESSION1234567890",
      "record_reference_id": "MET1234567890",
      "energy": {
        "value": 10284
      },
      "tariff": {
        "value": 928.372,
        "confidence": 1
      },
      "carbon": {
        "value": 35.24,
        "confidence": 0.8
      }
    }
  ],
  "account_id": "acc_661677911f2197045e6cf1b1"
}

Authorizations

​
Authorization
string
header
required

Authenticate with bearer_token you obtained from /login endpoint.

Path Parameters

​
id
string
required

FlatPeak location_id or device_id.

Query Parameters

​
aggregation
string

Aggregation interval, supported values are DAY, MONTH.

Example:

"MONTH"

​
direction
string
default:IMPORT

Indicates direction you want to work with. Set to IMPORT or EXPORT. Defaults to IMPORT.

Example:

"IMPORT"

​
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
​
start_time
string

Period 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:

"2023-11-07T05:31:56Z"

​
end_time
string

Period 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:

"2023-12-07T05:31:56Z"

Response

200
application/json
​
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.

​
direction
string

Indicates energy direction. Supported values are IMPORT and EXPORT.

Example:

"IMPORT"

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

​
energy_units
string

Units of energy measure.

Example:

"WH"

​
carbon_units
string

Units of carbon emissions measure.

Example:

"gCO2eq"

​
data
object[]

Value of energy object

Was this page helpful?

Suggest editsRaise issue