# Flatpeak

## Docs

- [Audit a price](https://docs.flatpeak.com/api-reference/anode/audits/audit-a-price.md): Returns audit of price calculation, by Location ID.
- [Authentication](https://docs.flatpeak.com/api-reference/anode/authentication.md): Flatpeak API uses bearer authentication to authorise access to endpoints. To create a bearer, use this endpoint with basic auth:
- [Advanced tariff capture (input)](https://docs.flatpeak.com/api-reference/anode/connect/advanced-tariff-capture.md): Provides advanced tariff configuration options.
- [Contract term capture (input)](https://docs.flatpeak.com/api-reference/anode/connect/contract-term-capture.md): Customer enters the date when their contract starts and/or expires.
- [Create a Connect token](https://docs.flatpeak.com/api-reference/anode/connect/create-a-connect-token.md): To start a Connect session, you must generate a connect_token.
- [Library selection](https://docs.flatpeak.com/api-reference/anode/connect/library-selection.md): Customer selects their tariff from a Flatpeak-provided library.
- [Manual tariff rate capture](https://docs.flatpeak.com/api-reference/anode/connect/manual-tariff-capture.md): Customer enters their tariff manually.
- [Postal address](https://docs.flatpeak.com/api-reference/anode/connect/postal-address.md): Customer enters their address
- [Provider login redirect](https://docs.flatpeak.com/api-reference/anode/connect/provider-login.md): Connect instructs you to redirect the customer to an external page.
- [Provider (supplier) selection](https://docs.flatpeak.com/api-reference/anode/connect/provider-selection.md): Customer selects their energy provider from the list or via manual input.
- [Region Selection](https://docs.flatpeak.com/api-reference/anode/connect/region-selection.md): Customer selects their market rates region.
- [Retrieve a Connect token](https://docs.flatpeak.com/api-reference/anode/connect/retrieve-a-connect-token.md): Retrieves the details of an existing connect token.
- [Server error](https://docs.flatpeak.com/api-reference/anode/connect/server-error.md): This page is returned when an error has occurred inside the Connect service.
- [Start a connect session](https://docs.flatpeak.com/api-reference/anode/connect/start-a-connect-session.md): Start a new session with Connect API.
- [Surcharge capture](https://docs.flatpeak.com/api-reference/anode/connect/surcharge-capture.md): Customer enters their tariff surcharges.
- [Failed tariff connection](https://docs.flatpeak.com/api-reference/anode/connect/tariff-connection-failed.md): Informs the customer that the tariff connection has failed.
- [Pending tariff connection](https://docs.flatpeak.com/api-reference/anode/connect/tariff-connection-pending.md): Informs customer that tariff connection is pending.
- [Tariff name capture (input)](https://docs.flatpeak.com/api-reference/anode/connect/tariff-name-capture.md): Customer enters their market rate surcharge.
- [Tariff structure selection](https://docs.flatpeak.com/api-reference/anode/connect/tariff-structure-selection.md): Customer selects their tariff from a Flatpeak-provided library.
- [Tariff Summary](https://docs.flatpeak.com/api-reference/anode/connect/tariff-summary.md): Shows tariff summary and energy price. Provides connection controls.
- [Calculate energy cost by session ID](https://docs.flatpeak.com/api-reference/anode/costs/calculate-energy-cost-by-session-id.md): Returns monetary value (cost) of energy by `session_reference_id` that have been previously submitted to a /meters endpoint.
- [Report historic energy cost](https://docs.flatpeak.com/api-reference/anode/costs/calculate-energy-cost-by-time-interval.md): Returns monetary value (cost) of energy by Flatpeak `location_id` or `device_id`. Meter records must have been previously submitted to the `/meters` endpoint.
- [Instantly calculate energy cost](https://docs.flatpeak.com/api-reference/anode/costs/instantly-calculate-energy-cost.md): Ingests a meter record and instantly returns the import or export monetary value (cost) of energy.
- [Create a customer](https://docs.flatpeak.com/api-reference/anode/customers/create-a-customer.md): Creates new customer.
- [Delete a customer](https://docs.flatpeak.com/api-reference/anode/customers/delete-a-customer.md): Permanently deletes a customer.
- [List all customers](https://docs.flatpeak.com/api-reference/anode/customers/list-all-customers.md): Returns all customer objects, sorted by creation date (newest first). If no parameters are provided, results are paginated in pages of 30.
- [Retrieve a customer](https://docs.flatpeak.com/api-reference/anode/customers/retrieve-a-customer.md): Retrieves the details of an existing customer.
- [Update a customer](https://docs.flatpeak.com/api-reference/anode/customers/update-a-customer.md): Updates the specified customer. Parameters not included in the request will remain unchanged.
- [Create a device](https://docs.flatpeak.com/api-reference/anode/devices/create-a-device.md): Creates a device identifier.
- [Delete a device](https://docs.flatpeak.com/api-reference/anode/devices/delete-a-device.md): Permanently deletes a device identifier.
- [List all devices](https://docs.flatpeak.com/api-reference/anode/devices/list-all-devices.md): Lists all device identifiers.
- [Retrieve a device](https://docs.flatpeak.com/api-reference/anode/devices/retrieve-a-device.md): Retrieves the details of an existing device identifier.
- [Update a device](https://docs.flatpeak.com/api-reference/anode/devices/update-a-device.md): Updates the specified device identifier. Any parameters that have not been provided will be left unchanged.
- [List all events](https://docs.flatpeak.com/api-reference/anode/events/list-all-events.md): Returns all events, sorted by creation date (newest first). If no parameters are provided, results are paginated in pages of 100.
- [Retrieve an event](https://docs.flatpeak.com/api-reference/anode/events/retrieve-an-event.md): Retrieves the details of an event.
- [API Reference (2025-09-14.anode)](https://docs.flatpeak.com/api-reference/anode/index.md)
- [Create a location](https://docs.flatpeak.com/api-reference/anode/locations/create-a-location.md): Creates a location.
- [Delete a location](https://docs.flatpeak.com/api-reference/anode/locations/delete-a-location.md): Permanently deletes a location.
- [List locations](https://docs.flatpeak.com/api-reference/anode/locations/list-locations.md): Returns all location objects, sorted by creation date (newest first). If no parameters are provided, results are paginated in pages of 30.
- [Retrieve a location](https://docs.flatpeak.com/api-reference/anode/locations/retrieve-a-location.md): Retrieves a location.
- [Retrieve a location status](https://docs.flatpeak.com/api-reference/anode/locations/retrieve-a-location-status.md): Retrieves the current status of a location.
- [Update a location](https://docs.flatpeak.com/api-reference/anode/locations/update-a-location.md): Updates the specified location. Parameters not included in the request will remain unchanged
- [Check processing status](https://docs.flatpeak.com/api-reference/anode/meters/check-meter-batch.md): Returns processing status of meter records batch when multiple records were submitted to meters endpoints.
- [Submit cumulative meter records](https://docs.flatpeak.com/api-reference/anode/meters/submit-meter-cumulative.md): Accepts array of meter records holding energy use as cumulative values.
- [Submit interval meter records](https://docs.flatpeak.com/api-reference/anode/meters/submit-meter-interval.md): Accepts an array of meter records holding energy use values for each period.
- [Retrieve a price](https://docs.flatpeak.com/api-reference/anode/prices/retrieve-a-price.md): Returns energy price, by Location ID.
- [Schedule by amount of energy](https://docs.flatpeak.com/api-reference/anode/schedules/schedule-by-amount.md): Find best times to consume or export energy based on: - Total energy required - Duration of time available - Power transfer speed limit
- [Schedule by time duration](https://docs.flatpeak.com/api-reference/anode/schedules/schedule-by-duration.md): Find the lowest or highest-cost time slots by specifying a required total duration.
- [Schedule by price limit](https://docs.flatpeak.com/api-reference/anode/schedules/schedule-by-limit.md): Find the lowest- or highest-cost periods by setting a maximum acceptable price.
- [Create a tariff](https://docs.flatpeak.com/api-reference/anode/tariffs/create-a-tariff.md): Creates a tariff.
- [Delete a tariff](https://docs.flatpeak.com/api-reference/anode/tariffs/delete-a-tariff.md): Permanently deletes a tariff. Will also automatically remove the tariff from `tariffs` property of the Location if linked.
- [List all tariffs](https://docs.flatpeak.com/api-reference/anode/tariffs/list-tariffs.md): Returns all tariff objects, sorted by creation date (newest first). If no parameters are provided, results are paginated in pages of 30.
- [Retrieve a tariff](https://docs.flatpeak.com/api-reference/anode/tariffs/retrieve-a-tariff.md): Retrieves a tariff. Use to fetch detailed information for a tariff referenced in the `tariffs` property of a Location object.
- [Platform updates](https://docs.flatpeak.com/changelog.md)
- [Report historic energy cost](https://docs.flatpeak.com/guides/calculate/historic.md)
- [Calculate and report energy cost with Flatpeak](https://docs.flatpeak.com/guides/calculate/index.md)
- [Instantly calculate energy cost](https://docs.flatpeak.com/guides/calculate/instant.md)
- [Incorporate on-site generation into cost calculations](https://docs.flatpeak.com/guides/calculate/local-generation.md)
- [How Flatpeak Connect works](https://docs.flatpeak.com/guides/connect/architecture.md)
- [Integrate tariff connection into your app](https://docs.flatpeak.com/guides/connect/index.md)
- [Regulatory compliance](https://docs.flatpeak.com/guides/connect/legal.md)
- [Retrieve energy price](https://docs.flatpeak.com/guides/connect/retrieve-price.md)
- [Add tariff settings page to your app](https://docs.flatpeak.com/guides/connect/settings-page.md)
- [Required webhooks](https://docs.flatpeak.com/guides/connect/webhooks.md)
- [Export your data from Flatpeak](https://docs.flatpeak.com/guides/migrate/export-your-data.md)
- [Import your data to Flatpeak](https://docs.flatpeak.com/guides/migrate/import-your-data.md)
- [Integrate Flatpeak with your internal support tools](https://docs.flatpeak.com/guides/migrate/integrate-support.md)
- [Automatically assign market tariff when you know customer's postal address](https://docs.flatpeak.com/guides/migrate/market-rates.md)
- [Create a schedule using an energy amount](https://docs.flatpeak.com/guides/schedule/amount.md)
- [Create a schedule by setting energy use duration](https://docs.flatpeak.com/guides/schedule/duration.md)
- [Schedule energy with Flatpeak](https://docs.flatpeak.com/guides/schedule/index.md)
- [Create a schedule by setting a price limit](https://docs.flatpeak.com/guides/schedule/limit.md)
- [Include local solar generation forecasts](https://docs.flatpeak.com/guides/schedule/solar-forecasts.md)
- [Grid fees](https://docs.flatpeak.com/guides/sources/grid-fees.md)
- [Data sources and coverage](https://docs.flatpeak.com/guides/sources/index.md)
- [Energy markets integrations](https://docs.flatpeak.com/guides/sources/market-rates.md)
- [Price forecasts](https://docs.flatpeak.com/guides/sources/price-forecasts.md)
- [Energy provider (supplier) integrations](https://docs.flatpeak.com/guides/sources/providers.md)
- [Objects deletion](https://docs.flatpeak.com/guides/system/deletion.md)
- [Errors](https://docs.flatpeak.com/guides/system/errors.md)
- [Events](https://docs.flatpeak.com/guides/system/events.md)
- [Pagination](https://docs.flatpeak.com/guides/system/pagination.md)
- [Core object relationships](https://docs.flatpeak.com/guides/system/structure.md)
- [Test (sandbox) mode](https://docs.flatpeak.com/guides/system/test-mode.md)
- [Timezones & Daylight Saving Time](https://docs.flatpeak.com/guides/system/timezones.md)
- [API Versioning](https://docs.flatpeak.com/guides/system/versioning.md)
- [Subscribing to events delivery via webhooks](https://docs.flatpeak.com/guides/system/webhooks.md)
- [Documentation](https://docs.flatpeak.com/index.md)
- [Acceptable Use Policy](https://docs.flatpeak.com/legal/acceptable-use-policy.md): Effective date: 18 February 2022
- [Update notices for Terms of Service](https://docs.flatpeak.com/legal/archives/terms-update-notices.md): Last updated: 30 January 2026
- [Corporate Social Responsibility report](https://docs.flatpeak.com/legal/csr-report.md): Report for year ending 31 December 2025
- [Data Processing Agreement](https://docs.flatpeak.com/legal/data-processing-agreement.md): Effective date: 1 November 2025
- [Data Disclosure Policy](https://docs.flatpeak.com/legal/disclosure-request.md): Effective date: 18 February 2022
- [Privacy Statement](https://docs.flatpeak.com/legal/privacy.md): Effective date: 18 February 2026
- [Service Level Agreement](https://docs.flatpeak.com/legal/service-level-agreement.md): Effective date: 15 April 2025
- [Subprocessors](https://docs.flatpeak.com/legal/subprocessors.md): Effective date: 20 February 2026
- [Support Policy](https://docs.flatpeak.com/legal/support-policy.md): Effective date: 22 February 2022
- [Terms of Service](https://docs.flatpeak.com/legal/terms.md): Effective date: 1 November 2025
- [Help us build a connected and smart energy system ⚡](https://docs.flatpeak.com/openenergy.md)
- [Quickstart](https://docs.flatpeak.com/quickstart.md)
- [Contact support](https://docs.flatpeak.com/support.md)

## OpenAPI Specs

- [flatpeak-api-spec-busbar](https://docs.flatpeak.com/api-reference/busbar/flatpeak-api-spec-busbar.json)
- [flatpeak-api-spec-zero](https://docs.flatpeak.com/api-reference/zero/flatpeak-api-spec-zero.json)
- [flatpeak-api-spec-anode](https://docs.flatpeak.com/api-reference/anode/flatpeak-api-spec-anode.json)
- [openapi](https://docs.flatpeak.com/api-reference/openapi.json)