> ## Documentation Index > Fetch the complete documentation index at: https://docs.nox.energy/llms.txt > Use this file to discover all available pages before exploring further. # Get Devices Battery Settings > **Preview: not available yet.** This endpoint is documented ahead of its release and currently answers `501 Not Implemented`. Its contract may still change before release. Get the settings of a specific battery or of all batteries of a user. ## OpenAPI ````yaml /api-docs/battery/openapi-battery.json get /v1/devices/battery/settings openapi: 3.1.0 info: title: NOX Energy API - Battery description: > # Battery API Documentation This documentation shows only the endpoints available to battery users. **Preview:** these endpoints are documented ahead of their release and currently answer `501 Not Implemented`. ## Authentication 1. Get your API key from [NOX Energy](mailto:support@nox.energy). 2. Include the API key in your API calls with the header: `x-api-key: YOUR_API_KEY`. ## Access Level This documentation is specifically for **battery users** who have access to these endpoints. Base URL: [https://api.nox.energy](https://api.nox.energy) version: 1.0.0 servers: - url: https://api.nox.energy description: Production Server security: - ApiKeyAuth: [] tags: - name: Asset Info description: API to get basic information about your assets. - name: Battery Control description: API for battery control specific endpoints. - name: User Management description: API endpoints to manage users and their data. paths: /v1/devices/battery/settings: get: tags: - User Management summary: Get Devices Battery Settings description: >- **Preview: not available yet.** This endpoint is documented ahead of its release and currently answers `501 Not Implemented`. Its contract may still change before release. Get the settings of a specific battery or of all batteries of a user. operationId: get_devices_battery_settings_v1_devices_battery_settings_get parameters: - name: device_id in: query required: false schema: anyOf: - type: string - type: 'null' description: > The ID of the device to filter on. If not provided, all devices are returned. title: Device Id description: > The ID of the device to filter on. If not provided, all devices are returned. - name: user_id in: query required: false schema: anyOf: - type: string - type: 'null' description: > Your own ID of the user to filter on: the ID you use internally for this user, whether you are an energy supplier, an OEM or another partner. If not provided, all users are returned. title: User Id description: > Your own ID of the user to filter on: the ID you use internally for this user, whether you are an energy supplier, an OEM or another partner. If not provided, all users are returned. responses: '200': description: Successful response for get battery settings endpoint. content: application/json: schema: $ref: '#/components/schemas/DevicesBatteryGetSettingsResponse' example: data: - device_id: e4da3b7f-bbce-4a45-9d2b-1c0e8f7a6b5c optimization_settings: pv_self_consumption: false dynamic_tariff: true flex_trading: false imbalance_optimization: true updated_at: '2026-10-17T09:27:09.224000+00:00' - device_id: 1679091c-5a88-4c2f-8e1d-3b2a0f9e8d7c optimization_settings: pv_self_consumption: false dynamic_tariff: false flex_trading: true imbalance_optimization: false updated_at: '2026-10-16T14:02:41.118000+00:00' meta: energy_supplier: Energy Supplier A '403': description: Your API key has no access to the battery features content: application/json: example: detail: Energy Supplier A is not authorized to access this feature. '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' '501': description: Not implemented yet content: application/json: example: detail: This endpoint is not available yet. components: schemas: DevicesBatteryGetSettingsResponse: properties: data: items: $ref: '#/components/schemas/DevicesBatteryGetSettings' type: array title: Data description: List of battery settings meta: $ref: '#/components/schemas/DevicesBatteryGetSettingsMeta' description: Response metadata type: object required: - data - meta title: DevicesBatteryGetSettingsResponse HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError DevicesBatteryGetSettings: properties: device_id: anyOf: - type: string - type: 'null' title: Device Id description: Battery device ID optimization_settings: anyOf: - $ref: '#/components/schemas/BatteryOptimizationSettings' - type: 'null' description: >- Optimization settings for flex trading, dynamic tariff, PV self-consumption and imbalance optimization updated_at: anyOf: - type: string - type: 'null' title: Updated At description: Timestamp of the last update of the settings in ISO format type: object title: DevicesBatteryGetSettings DevicesBatteryGetSettingsMeta: properties: energy_supplier: anyOf: - type: string - type: 'null' title: Energy Supplier description: Energy supplier name type: object title: DevicesBatteryGetSettingsMeta ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError BatteryOptimizationSettings: properties: pv_self_consumption: anyOf: - type: boolean - type: 'null' title: Pv Self Consumption description: Enable/disable PV self-consumption optimization dynamic_tariff: anyOf: - type: boolean - type: 'null' title: Dynamic Tariff description: Enable/disable dynamic tariff optimization flex_trading: anyOf: - type: boolean - type: 'null' title: Flex Trading description: >- Enable/disable supplier flex trading. If `True`, the supplier steers the battery based on the schedules they provide to NOX Energy. imbalance_optimization: anyOf: - type: boolean - type: 'null' title: Imbalance Optimization description: >- Enable/disable imbalance optimization. If `True`, the battery will be optimized to minimize imbalances based on the imbalance prices of the users country. additionalProperties: false type: object title: BatteryOptimizationSettings securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: 'API Key authentication. Enter your API key in the format: YOUR_API_KEY' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.