evcc (self-hosted)

evcc (self-hosted) Vehicles API

The vehicles API from evcc (self-hosted) — 10 operation(s) for vehicles.

GitHub OpenAPI
Business capability
Home, Device & Consumer IoT AE-200

Operations 10

POST /vehicles/{name}/limitsoc/{soc} Set SoC limit #
POST /vehicles/{name}/minsoc/{soc} Set minimum SoC #
DELETE /vehicles/{name}/mode Reset charge mode #
POST /vehicles/{name}/mode/{mode} Set charge mode #
DELETE /vehicles/{name}/alwayscharge Reset always charge #
POST /vehicles/{name}/alwayscharge/{alwaysCharge} Set always charge #
POST /vehicles/{name}/plan/repeating Update repeating plans #
DELETE /vehicles/{name}/plan/soc Delete a SoC-based charging plan #
POST /vehicles/{name}/plan/soc/{soc}/{timestamp} Set a SoC-based charging plan #
POST /vehicles/{name}/plan/strategy Set plan strategy #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/evcc/openapi/evcc-vehicles-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/evcc/json-schema/evcc-state-schema.json
📊
JSONSchema
https://artifacts.apis.io/evcc/json-schema/evcc-grid-sessions-schema.json
📊
JSONSchema
https://artifacts.apis.io/evcc/json-schema/evcc-charging-sessions-schema.json
📊
JSONSchema
https://artifacts.apis.io/evcc/json-schema/evcc-repeating-plan-schema.json
📊
JSONSchema
https://artifacts.apis.io/evcc/json-schema/evcc-flow-schema.json
📊
JSONSchema
https://artifacts.apis.io/evcc/json-schema/evcc-onboarding-state-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/evcc:evcc-vehicles-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

evcc-vehicles-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: evcc Vehicles API
  description: smart charging. open source energy management.
  version: 0.2.0
  contact:
    url: https://github.com/evcc-io/evcc
servers:
- url: https://demo.evcc.io/api
tags:
- name: Vehicles
paths:
  /vehicles/{name}/limitsoc/{soc}:
    post:
      operationId: setVehicleSocLimit
      summary: Set SoC limit
      description: Charging will stop when this SoC is reached.
      externalDocs:
        url: https://docs.evcc.io/en/features/limits
      tags:
      - Vehicles
      parameters:
      - $ref: '#/components/parameters/vehicleName'
      - $ref: '#/components/parameters/soc'
      responses:
        '200':
          $ref: '#/components/responses/SocResult'
  /vehicles/{name}/minsoc/{soc}:
    post:
      operationId: setVehicleMinSoc
      summary: Set minimum SoC
      description: Vehicle will be fast-charged until this SoC is reached.
      externalDocs:
        url: https://docs.evcc.io/en/features/limits
      tags:
      - Vehicles
      parameters:
      - $ref: '#/components/parameters/vehicleName'
      - $ref: '#/components/parameters/soc'
      responses:
        '200':
          $ref: '#/components/responses/SocResult'
  /vehicles/{name}/mode:
    delete:
      operationId: deleteVehicleMode
      summary: Reset charge mode
      description: Resets the vehicle charge mode to keep the last selected mode.
      externalDocs:
        url: https://docs.evcc.io/en/features/solar-charging
      tags:
      - Vehicles
      parameters:
      - $ref: '#/components/parameters/vehicleName'
      responses:
        '200':
          $ref: '#/components/responses/NullResult'
  /vehicles/{name}/mode/{mode}:
    post:
      operationId: setVehicleMode
      summary: Set charge mode
      description: Sets the charge mode applied when this vehicle becomes active on a loadpoint.
      externalDocs:
        url: https://docs.evcc.io/en/features/solar-charging
      tags:
      - Vehicles
      parameters:
      - $ref: '#/components/parameters/vehicleName'
      - $ref: '#/components/parameters/mode'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  mode:
                    $ref: '#/components/schemas/ChargeMode'
  /vehicles/{name}/alwayscharge:
    delete:
      operationId: deleteVehicleAlwaysCharge
      summary: Reset always charge
      description: Resets the vehicle always charge default to keep the loadpoint state.
      externalDocs:
        url: https://docs.evcc.io/en/features/solar-charging
      tags:
      - Vehicles
      parameters:
      - $ref: '#/components/parameters/vehicleName'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  alwaysCharge:
                    anyOf:
                    - $ref: '#/components/schemas/VehicleAlwaysCharge'
                    - type: string
                      enum:
                      - ''
  /vehicles/{name}/alwayscharge/{alwaysCharge}:
    post:
      operationId: setVehicleAlwaysCharge
      summary: Set always charge
      description: Sets the always charge state applied when this vehicle becomes active on a loadpoint.
      externalDocs:
        url: https://docs.evcc.io/en/features/solar-charging
      tags:
      - Vehicles
      parameters:
      - $ref: '#/components/parameters/vehicleName'
      - $ref: '#/components/parameters/vehicleAlwaysCharge'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  alwaysCharge:
                    $ref: '#/components/schemas/VehicleAlwaysCharge'
  /vehicles/{name}/plan/repeating:
    post:
      operationId: updateVehicleRepeatingPlans
      summary: Update repeating plans
      description: Updates the repeating charging plan.
      externalDocs:
        url: https://docs.evcc.io/en/features/plans
      tags:
      - Vehicles
      parameters:
      - $ref: '#/components/parameters/vehicleName'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/RepeatingPlan'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RepeatingPlan'
  /vehicles/{name}/plan/soc:
    delete:
      operationId: deleteVehicleSocPlan
      summary: Delete a SoC-based charging plan
      description: Delete the charging plan
      externalDocs:
        url: https://docs.evcc.io/en/features/plans
      tags:
      - Vehicles
      parameters:
      - $ref: '#/components/parameters/vehicleName'
      responses:
        '200':
          $ref: '#/components/responses/EmptyResult'
  /vehicles/{name}/plan/soc/{soc}/{timestamp}:
    post:
      operationId: setVehicleSocPlan
      summary: Set a SoC-based charging plan
      description: Create charging plan with fixed time and SoC target.
      externalDocs:
        url: https://docs.evcc.io/en/features/plans
      tags:
      - Vehicles
      parameters:
      - $ref: '#/components/parameters/vehicleName'
      - $ref: '#/components/parameters/soc'
      - $ref: '#/components/parameters/timestamp'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  soc:
                    $ref: '#/components/schemas/Soc'
                  time:
                    $ref: '#/components/schemas/Timestamp'
  /vehicles/{name}/plan/strategy:
    post:
      operationId: setVehiclePlanStrategy
      summary: Set plan strategy
      description: Updates the charging plan strategy for the vehicle.
      externalDocs:
        url: https://docs.evcc.io/en/features/plans
      tags:
      - Vehicles
      parameters:
      - $ref: '#/components/parameters/vehicleName'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlanStrategy'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanStrategy'
components:
  schemas:
    Soc:
      description: SoC in %
      type: number
      example: 60
      minimum: 0
      maximum: 100
    RepeatingPlan:
      description: A repeating charging plan.
      type: object
      properties:
        weekdays:
          description: Weekdays the plan is active. 0 is Sunday, 6 is Saturday.
          type: array
          items:
            type: number
        time:
          description: Target time in HH:MM format.
          type: string
        tz:
          description: Time zone of the target time, like Europe/Berlin.
          type: string
        soc:
          description: SoC goal in %.
          type: number
        active:
          description: Plan is active.
          type: boolean
      required:
      - weekdays
      - time
      - tz
      - soc
      - active
    PlanStrategy:
      description: Charging plan strategy.
      type: object
      properties:
        continuous:
          description: Force continuous charging without gaps.
          type: boolean
        precondition:
          description: Duration of uninterrupted charging directly before the target time, in seconds.
          type: number
      required:
      - continuous
      - precondition
    ChargeMode:
      description: Charging mode.
      type: string
      enum:
      - 'off'
      - smart
      - now
    VehicleName:
      externalDocs:
        url: https://docs.evcc.io/en/reference/configuration/vehicles#name
      type: string
      minLength: 1
      pattern: '[a-zA-Z0-9_.:-]+'
      example: vehicle_1
    VehicleAlwaysCharge:
      description: Always charge default applied on identification. Once is not supported for vehicles.
      type: string
      enum:
      - 'off'
      - 'on'
    ChargeModeInput:
      description: 'Charging behavior. The values `pv` and `minpv` are deprecated aliases: `pv` maps to `smart`, `minpv` maps to `smart` with always charge enabled.'
      type: string
      enum:
      - 'off'
      - smart
      - now
      - pv
      - minpv
      example: smart
    Timestamp:
      description: Timestamp in RFC3339 format
      type: string
      format: date-time
  parameters:
    timestamp:
      name: timestamp
      description: Timestamp in RFC3339 format
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/Timestamp'
    vehicleName:
      name: name
      description: Vehicle name
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/VehicleName'
    mode:
      name: mode
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/ChargeModeInput'
    soc:
      name: soc
      description: SoC in %
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/Soc'
    vehicleAlwaysCharge:
      name: alwaysCharge
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/VehicleAlwaysCharge'
  responses:
    EmptyResult:
      description: Success - Empty result
      content:
        application/json:
          schema:
            type: object
    NullResult:
      description: Success - Null result
      content:
        application/json:
          schema:
            description: Value is always null
            nullable: true
            type: object
    SocResult:
      description: Success - SoC result
      content:
        application/json:
          schema:
            type: object
            properties:
              soc:
                $ref: '#/components/schemas/Soc'
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: auth
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Long-lived API key (prefixed `evcc_`, managed via /auth/apikey).

        Grants access to /api/db/* without requiring the X-Admin-Password header.

        '