Voltra developer docs
Build on the Voltra API. Start with a step-by-step flow, read the guide for the job you are doing, and look up any resource or endpoint.
Base URL api.voltra.comGet an API key
Flows
Guides
Get set up
Sites and chargers
- Charging session lifecycleThe records one charge creates, and the IDs that link them.
- Create a site and add chargers to itSet up a location, put it on a circuit limit and add its chargers.
- Pricing and paymentsFrom a pricing policy to a captured payment, and the IDs that link them.
- Site IDs and how sites syncWhich site ID to store and send, and why a new site takes a moment to sync.
Devices and energy
Working with the API
- API conventionsPagination, safe retries, rate limits and request IDs on every call.
- API deprecations and migrations: changes and deadlinesDeprecations, their deadlines and the new request for each.
- Build on the Connect APIList devices, read values, send a command and aggregate history with curl.
- Connect to Voltra as a roaming partnerRegister with OCPI 2.2.1 and read Voltra's locations and tariffs.
- ErrorsLook up any error by status and code, with its cause and fix.
- Model your sites with the Ontology APIModel sites as typed objects, walk the hierarchy, and read live data.
Resources
- API keyThe secret that authenticates calls to the Voltra APIs.
- Audit eventAn audit event records one security-relevant thing that happened to a device: a sign-in, a credential change, a revoke or a command dispatch.
- ChargerAn OCPP charge point registered in a project.
- CommandA command asks one device to do one thing: write a setpoint, run an action or apply a configuration.
- Data bridgeStream your organization's charger logs and device telemetry to storage or a log service you own.
- Data sourceA data source is a ready-made query a dashboard can show, such as one data point of a device over time.
- DeviceA device is a meter, inverter, battery or other site equipment that Voltra connects to and reads, other than an OCPP charger.
- GatewayA gateway is a Voltra edge box on your site network that polls the equipment behind it and reports to Voltra.
- Graph and containmentThe graph connects your objects through typed relationships, and the containment hierarchy places them site by site.
- Load managementKeep the chargers on one circuit within its current limit.
- ObjectAn object is one typed thing in your ontology: a site, a room, a rack, a meter or any other asset.
- OCPI roamingVoltra acts as a charge point operator (CPO) on OCPI 2.2.1 and shares its locations, charge points, connectors and tariffs with roaming partners.
- OrganizationYour Voltra account, called a workspace in the Console.
- Payment providerA payment provider connects your project to the account that receives driver payments.
- Payment transactionA payment transaction holds money on a driver's card, then captures the final amount or releases the hold.
- Pricing policyA pricing policy says what a charging session costs, as a per-kWh, per-minute, per-hour or flat price, or a schedule of them by time of day.
- ProjectA project groups chargers, sites and prices inside your organization.
- Proxy configurationRelay a charger's OCPP connection to another charging platform.
- QR codesShortcodes for the QR codes printed on chargers.
- Resolved priceA resolved price is the price a pricing policy gives at one moment, with when it changes next.
- SiteA site, also called a location, is a physical place such as a car park, depot or building.
- Telemetry, events and snapshotsRead an object's time-series data, follow every change to your ontology, rebuild state at any point in time, read snapshots, and submit commands.
- Type and interfaceTypes, interfaces, property definitions and relationship types make up your ontology's schema.
- Values and observationsA value is a capability's current reading; an observation is one immutable reading in its history.
- API referenceEvery endpoint, grouped by resource.