ev.energy Vehicles API is one of 25 APIs that ev.energy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Vehicles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.
This API exposes
38 operations
across 28 paths,
and defines 41 schemas.
It is described by OpenAPI 3.2.0, at version 2.0.
Requests are made against 2 base URLs: https://api.ev.energy/v2, https://api-staging.ev.energy/v2.
The identity and technical contract details declared by the specification.
ev.energy Vehicles API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the clientCredentials and authorizationCode flows, exposing 35 scopes.
By default, every request must be authenticated.
VehicleAPIErrorLog
object
Records an error that occurred when attempting to communicate with a vehicle's telematics API.
11 properties
Supplier
object
An energy company who supplies electricity tariffs.
5 properties
4 required
VehicleModelWrite
object
Fields that must be set when creating a VehicleModel resource.
2 properties
2 required
Times
object
Defines a period of time.
2 properties
VehicleCompatibilityCheckResult
object
Compatibility verdict for a (vehiclemodel, country) pair. Returned by GET /vehiclecompatibility/check.
2 properties
2 required
VehicleWaitlistRequest
object
Request body for POST /vehiclewaitlist. Device identification fields are mutually constrained: supply exactly one of (vehiclemodelid) or (both vehiclemakename…
5 properties
1 required
DailyPrices
object
Information about the tariff's prices for different parts of the day.
3 properties
1 required
VehicleCommandLog
object
Records a command that was sent to a vehicle.
7 properties
Tariff
Note: dailyprices and type are only available under contract. Please reach out to your account manager to find out more.
EVSESite
object
Represents a place with one or more EVSEs installed which can be accessed by multiple users.
6 properties
4 required
VehicleConnectorsUpdate
object
Request body for PATCH /vehicles/{vehicleid}/connectors.
2 properties
VehicleStatusLog
object
Records the state of a Vehicle at a particular point in time.
19 properties
VehicleModelConnectorPatch
object
Request body for PATCH /vehiclemodels/{vehiclemodelid}/connectors/{region}. All fields are optional; only those supplied are changed. region is the key and can…
4 properties
Location
object
Location model for charging locations. Address validation: Address fields are optional as a group, but each field independently triggers the requirement. If an…
9 properties
Vehicle
object
A resource representing a single, physical electric vehicle.
14 properties
10 required
VehicleReconnectionUrl
object
A URL for a user to re-authenticate their vehicle alongside it's metadata.
2 properties
VehicleWaitlistResponse
object
Response body for POST /vehiclewaitlist. Echoes just the new entry's uid; no url is returned because the endpoint exposes no retrieve action (privacy by design…
1 property
1 required
VehicleModelUpdate
object
Request body for PATCH /vehiclemodels/{vehiclemodelid}.
1 property
CountryCode
string
ISO 3166-1 2 letter Country Codes.
VehicleStateOfCharge
object
A vehicle's current battery state of charge.
5 properties
5 required
LocationDetail
Extra fields only included when a single location is requested but omitted when locations are listed.
PriceSummary
object
A single price for a certain time range.
2 properties
VehicleMake
object
A resource representing a vehicle manufacturer.
8 properties
6 required
VehicleConnectors
object
A vehicle's DC-fast charging connectors (native plug + adapters).
5 properties
5 required
VehicleModel
object
A resource representing a model of vehicle.
8 properties
5 required
VehicleOnboardingCompleteResponse
object
Response body for POST /vehicleonboarding/complete. Always an array; the single-vehicle case is returned as a one-element list.
1 property
1 required
VehicleTrim
object
A resource representing a "trim level" of a particular vehicle model, which captures a specific set of features.
6 properties
4 required
RFC9457ProblemDetail
object
6 properties
2 required
VehicleOnboardingJsonResponse
object
JSON payload returned by GET /vehicleonboarding?responsetype=json. Used by native mobile clients to launch the onboarding flow.
5 properties
3 required
Notification
object
Something that the user should be informed about.
13 properties
11 required
VehicleWrite
object
Fields that can be set when creating an unintegrated Vehicle resource. The client supplies a model (and optional batterysizewatthours); the backend resolves or…
5 properties
1 required
VehicleLocationLog
object
Records when location data was sampled for a vehicle. The actual location coordinates are not exposed through this resource.
5 properties
VehicleModelConnectorCreate
object
Request body for POST /vehiclemodels/{vehiclemodelid}/connectors.
5 properties
2 required
VPPModes
object
VPP (Virtual Power Plant) mode capabilities indicating which control modes are supported by the resource.
4 properties
4 required
TariffBase
object
Core tariff properties shared by Tariff and expanded schedulertariff. Note: dailyprices and type are only available under contract. Please reach out to your ac…
13 properties
5 required
User
object
A resource that represents an individual user in the ev.energy system.
9 properties
2 required
VehicleModelConnector
object
A vehicle model's DC-fast connector for one charging region. A model's connector can differ by market, so each row records the connector (and its provenance) f…
8 properties
8 required
VehicleStateOfChargeUpdate
object
Request body for PATCH /vehicles/{vehicleid}/stateofcharge.
1 property
VehicleTrimCreate
object
Request body for creating a custom vehicle trim.
3 properties
3 required
LatLong
object
Coordinates model used for locations.
2 properties
2 required
VehicleOnboardingCompleteRequest
object
Request body for POST /vehicleonboarding/complete. Exchanges a provider authcode (typically returned by the Smartcar Connect native SDK) for the list of vehicl…
3 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs ev.energy publishes across the network.
