Once the tariff is successfully discovered, Connect returns this final page.Documentation Index
Fetch the complete documentation index at: https://docs.flatpeak.com/llms.txt
Use this file to discover all available pages before exploring further.
- Preview
- Code
{
"connect_token": "cot_6587fa4362341be5b524de3b",
"route": "location_summary",
"location_id": "loc_641b90b758fb8e6293716e40",
"timezone": "Europe/London",
"currency_code": "GBP",
"live_mode": false,
"actions":
[
"ERROR_REPORT",
"DISCONNECT",
"CLOSE",
"BACK"
],
"tariff_status":
{
"commodity_import":
{
"status": "CONNECTED",
"tariff_id": "trf_66ba584eb6923d7c3b942ef6",
"connection_type": "DIRECT",
"market_rates_source": true,
"tiered": false,
"display_name": "Agile Octopus v3 2024",
"is_temporary": false,
"provider":
{
"id": "prv_63a6087272921ef075a8fd3e",
"display_name": "Octopus Energy",
"logo_url": "https://s.flatpeak.com/83b06a60e38c2.png"
},
"prices":
{
"yesterday":
[],
"today":
[
{
"valid_from": "2024-02-01T00:00:00+02:00",
"valid_to": "2024-02-01T22:00:00+02:00",
"price":
{
"cost": 0.12,
"confidence": 1
}
},
{
"valid_from": "2024-02-01T22:00:00+02:00",
"valid_to": "2024-02-01T00:00:00+02:00",
"price":
{
"cost": 0.09,
"confidence": 1
}
}
],
"tomorrow":
[
{
"valid_from": "2024-02-02T00:00:00+02:00",
"valid_to": "2024-02-02T06:00:00+02:00",
"price":
{
"cost": 0.09,
"confidence": 1
}
},
{
"valid_from": "2024-02-02T06:00:00+02:00",
"valid_to": "2024-02-03T00:00:00+02:00",
"price":
{
"cost": 0.12,
"confidence": 1
}
}
]
}
},
"commodity_export":
{
"status": "CONNECTED ",
"id": "trf_66fa584eb6923d7c3b942ef8",
"connection_type": "MANUAL",
"market_rates_source": true,
"tiered": false,
"display_name": "Agile Octopus v3 2024",
"is_temporary": false,
"provider":
{
"id": "prv_63374fb151ea87296cd39ced",
"display_name": "E.ON Next",
"logo_url": "https://s.flatpeak.com/83b06a60e38c2.png"
},
"prices":
{
"yesterday":
[],
"today":
[
{
"valid_from": "2024-02-01T00:00:00+02:00",
"valid_to": "2024-02-01T22:00:00+02:00",
"price":
{
"cost": 0.12,
"confidence": 1
}
},
{
"valid_from": "2024-02-01T22:00:00+02:00",
"valid_to": "2024-02-01T00:00:00+02:00",
"price":
{
"cost": 0.09,
"confidence": 1
}
}
],
"tomorrow":
[
{
"valid_from": "2024-02-02T00:00:00+02:00",
"valid_to": "2024-02-02T06:00:00+02:00",
"price":
{
"cost": 0.09,
"confidence": 1
}
},
{
"valid_from": "2024-02-02T06:00:00+02:00",
"valid_to": "2024-02-03T00:00:00+02:00",
"price":
{
"cost": 0.12,
"confidence": 1
}
}
]
}
},
"non_commodity_import":
{
"status": "ERROR",
"id": "trf_66fa584eb6923d7c3b942ef8",
"connection_type": "MANUAL",
"market_rates_source": true,
"tiered": false,
"display_name": "Agile Octopus v3 2024",
"temporary": false,
"provider":
{
"id": "prv_63a6087272921ef075a8fd3e",
"display_name": "Octopus Energy",
"logo_url": "https://s.flatpeak.com/83b06a60e38c2.png"
},
"prices":
{
"yesterday":
[],
"today":
[],
"tomorrow":
[]
}
},
"local":
{
"status": "NOT_CONNECTED"
}
}
}
| Error Code | Error Description |
|---|---|
action_missing | Action parameter is required. |
action_invalid | Action parameter XX is not supported. |
data_json_invalid | Data does not conform to the JSON schema. |
Note, time is returned in RFC3339 format with offset. i.e. 2024-06-15T03:12:00+02:00
| Action | Result |
|---|---|
EDIT | Restarts the flow from the Provider Selection page. |
DISCONNECT | Disconnects the tariff and completes the session. |
WRONG_TARIFF | Report incorrect tariff to Flatpeak. Not available if already reported. |
BACK | Returns previous page. |
CLOSE | Returns callback_url you specified when creating the Connect token. |