> ## Documentation Index > Fetch the complete documentation index at: /docs/llms.txt > Use this file to discover all available pages before exploring further. # Optimize by state of charge > Returns the charging profile that reaches the charge target in the latest device state: `battery.target_state_of_charge_percent`, or `vehicle.charge_limit_percent` by `vehicle.time_departure`. ## OpenAPI ````yaml energy-api/reference/flatpeak-api-spec-energy.json POST /devices/{device_id}/optimizations/soc openapi: 3.0.3 info: description: >- The Flatpeak Energy API connects energy hardware (batteries, EV chargers, vehicles, heat pumps, water heaters, solar and generators) to electricity prices, grid fees, and VPP programs. ## Create bearer token Obtain a bearer token from `POST /auth/tokens` using your `account_id` and `secret_key` via basic auth, then send it as `Authorization: Bearer ` on every request. ## Base URL `https://energy-api.flatpeak.com` ## Pagination List endpoints return a `list` envelope with `data`, `next_cursor`, and `url`. Page forward by passing `next_cursor` as `cursor` on the next request, until it is `null`. Cursors are opaque and bound to the endpoint and query parameters that issued them. ## Errors Every non-2xx response uses a standard error envelope with `object`, `type`, `code`, and `message`. Codes are machine-readable and safe to branch on. ## Money Monetary values are decimal numbers and are always paired with a `currency_code` (ISO 4217). Energy is expressed in kilowatt hours (kWh). ## Live vs test `live_mode` marks live or test data. version: 2027-01-01.busbar title: Flatpeak Energy API termsOfService: https://flatpeak.com/legal contact: name: Technical Support email: support@flatpeak.com url: https://flatpeak.com/contact license: name: Apache 2.0 url: https://flatpeak.com/legal servers: - url: https://energy-api.flatpeak.com security: - bearerAuth: [] tags: - name: Authentication description: >- Exchange your account credentials for a bearer token to authenticate API requests. - name: Connect description: >- Create and retrieve Connect sessions. Connect drives the user journeys for tariff connection, VPP enrollment, and [tariff error reporting](/energy-api/reference/connect/tariff/error-report). What happens in those journeys reaches your backend as [Connect webhooks](/energy-api/guides/platform/events). x-tariff-description: >- Create and retrieve Connect sessions. Connect drives the user journeys for tariff connection and [tariff error reporting](/energy-api/reference/connect/tariff/error-report). What happens in those journeys reaches your backend as [Connect webhooks](/energy-api/guides/platform/events). - name: Users description: Create, retrieve, update, delete, and list users. - name: Locations description: Create, retrieve, update, delete, and list locations. - name: Devices description: >- Create, retrieve, update, delete and list devices; submit and retrieve their state; read and write their shared settings. - name: Meters description: Submit meter records and check batch status. - name: Tariffs description: Create, retrieve, delete, and list tariffs. - name: Prices description: Retrieve and audit calculated energy prices. - name: Costs description: Calculate the monetary cost of imported or exported energy. - name: Optimizations description: >- Rank the connected tariff to find the best times to consume or export energy, as inputs to your own scheduling. - name: Dispatch description: >- Fetch the VPP operator's instructions for a device, and confirm what the device will deliver. - name: Events description: Retrieve and list account events. - name: VPP Enrollments description: Create, retrieve and list VPP enrollments, and unenroll a device. - name: VPP Programs description: List VPP programs available to devices. - name: VPP Events description: >- VPP events committed by VPP operators, with your fleet's share and its per-device allocation. You can take over the allocation while it is open. - name: Operator groups description: >- Read-only views of the device groups VPP operators define. You see the groups that touch your fleet, and only your own devices in them. - name: Zones description: >- Network areas VPP operators define that touch your fleet. Read-only. You see only your own devices in them. externalDocs: description: Documentation url: https://docs.flatpeak.com paths: /devices/{device_id}/optimizations/soc: parameters: - name: device_id in: path required: true schema: type: string example: dev_63a6087272941ef077a8fd3e description: Flatpeak Device ID. post: tags: - Optimizations summary: Optimize by state of charge description: >- Returns the charging profile that reaches the charge target in the latest device state: `battery.target_state_of_charge_percent`, or `vehicle.charge_limit_percent` by `vehicle.time_departure`. operationId: optimize-by-soc parameters: [] requestBody: $ref: '#/components/requestBodies/OptimizeBySocCreate' responses: '200': $ref: '#/components/responses/OptimizeBySoc' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '503': $ref: '#/components/responses/503' components: requestBodies: OptimizeBySocCreate: content: application/json: schema: type: object additionalProperties: false properties: storm_mode_enabled: type: boolean description: >- Overrides the device's `storm_mode_enabled` setting for this request only. Omit to use the setting from the latest device state. example: false required: true responses: '400': description: >- 400 Bad Request: the request was malformed or a required field is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: '401 Unauthorized: authentication credentials are missing or invalid.' content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: '403 Forbidden: you do not have permission to access this resource.' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: '404 Not Found: the requested resource does not exist.' content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: >- 422 Unprocessable Entity: the request is well-formed but cannot be processed, for example missing required data. content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: '429 Too Many Requests: the rate limit has been exceeded.' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: >- 500 Internal Server Error: an unexpected error occurred. Safe to retry with backoff. content: application/json: schema: $ref: '#/components/schemas/Error' '503': description: >- 503 Service Unavailable: the service is temporarily down for maintenance. Retry after the indicated delay. content: application/json: schema: $ref: '#/components/schemas/Error' OptimizeBySoc: description: Optimization by state of charge response. content: application/json: schema: $ref: '#/components/schemas/OptimizationBySoc' schemas: OptimizationBySoc: title: OptimizationBySoc type: object properties: id: type: string example: opt_65ea3fb185c1541f247c251e description: Flatpeak Optimization ID. object: type: string example: optimization_soc description: Object type. enum: - optimization_soc live_mode: type: boolean description: '`true` for live data, `false` for test data.' example: true device_id: type: string example: dev_6563a6757360a6d6a628e839 description: Flatpeak Device ID. location_id: type: string example: loc_641b90b758fb8e6293716e40 description: Flatpeak Location ID. timezone: type: string description: Timezone at the location, tz database name such as `Europe/Berlin`. example: Europe/London currency_code: type: string example: GBP description: Currency of the cost values. Amounts are in large currency units. pattern: ^[A-Z]{3}$ data: type: array items: $ref: '#/components/schemas/OptimizationData' description: The price windows of the optimization, in time order. account_id: type: string example: acc_661677911f2197045e6cf1b1 description: Flatpeak Account ID. time_created: type: string format: date-time example: '2026-01-24T14:15:22Z' description: Time when this object was created, in UTC. required: - id - object - live_mode - device_id - location_id - timezone - currency_code - data - account_id - time_created Error: type: object description: Standard error envelope returned by every non-2xx response. required: - object - type - code - message properties: object: type: string enum: - error default: error description: Object type. type: type: string description: High-level error category. example: invalid_request code: type: string description: Machine-readable error code, safe to branch on. example: not_found message: type: string description: Human-readable description of the error. example: The requested resource could not be found. context: type: string description: Optional originating context, for example `api.price_get`. example: api.price_get live_mode: type: boolean description: Whether the error occurred against live or test data. time_created: type: string format: date-time description: Time the error was generated (RFC 3339). example: '2026-01-01T00:00:00Z' OptimizationData: title: OptimizationData type: object description: >- A single optimization segment. Power values are signed: positive for import, negative for export. properties: start_time: type: string description: Segment start. example: '2026-05-20T00:00:00Z' format: date-time end_time: type: string description: Segment end. example: '2026-05-20T05:30:00Z' format: date-time power_kw: type: number description: >- Power, in kilowatts. Positive values indicate import, negative values indicate export. `null` if unavailable. example: 2.1034 nullable: true storm_mode_active: type: boolean default: false description: >- `true` when storm mode shapes the period: the optimization holds or builds charge ahead of forecast severe weather, from the device's `storm_mode_enabled` setting or the `storm_mode_enabled` override in the request. price: type: object description: >- Average energy price for the segment: the tariff price at which energy settles during the window. properties: value: type: number description: The average price, in large currency units. example: 3.221 confidence: type: number description: >- Estimated confidence of the data: `1` is 100% accurate, `0.1` is 10%. example: 1 securitySchemes: bearerAuth: type: http scheme: bearer description: Bearer token obtained from POST /auth/tokens. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.