Epic-Charging Server Application Report API (v1)

Epic-Charging API

Welcome to the Epic-Charging API documentation. This API gives you full control over your EV charging infrastructure, allowing you to manage chargers, monitor sessions, and generate reports.

Getting Started

To use the Epic-Charging API, you'll need:

An API Key (see the Authentication section)
A basic understanding of the resources available through the API

Base URL

All API URLs referenced in this documentation are relative to:

https://{{tenant}}.epiccharging.com/api/external/v1/

Authentication

The Epic-Charging API uses API keys for authentication. Include your API key in all requests using the Token-Authorization header:

curl -X GET https://{{tenant}}.epiccharging.com/api/external/v1/charger/ \
  -H "Token-Authorization: your_api_key_here"

Your API key carries privileges, so keep it secure. Do not share it in publicly accessible areas such as GitHub, client-side code, or public forums.

Rate Limiting

API requests may be subject to rate limiting. If you exceed the rate limit, the API will respond with a 429 Too Many Requests status code.

Error Responses

The API uses standard HTTP response codes to indicate success or failure:

2xx: Success
4xx: Client errors (invalid request, unauthorized, etc.)
5xx: Server errors

Error responses include a JSON body with details about the error.

Download OpenAPI description

index.json

index.yaml

Servers

Server

https://{tenant}.epiccharging.com/api/external/v1/

Charger Port

Charger Ports represent the individual connector points where vehicles can be connected for charging.

Use these endpoints to:

List all available charger ports across your network
Get detailed information about specific ports
Update port settings and configurations
Reserve ports for future use
Start and stop charging sessions
Cancel reservations

Each charger port belongs to a parent charger and can have different connector types (J1772, CCS, CHADEMO, etc.) and power capacities. Ports also maintain status information about current charging activities.

Operations

Charger

Chargers are the physical stations containing one or more charging ports.

These endpoints allow you to:

List all chargers in your network with their current statuses
Get detailed information about specific chargers
View power, connectivity, and location information
See all ports associated with a charger

Chargers contain important metadata about locations, payment types, power capabilities, and operating temperatures. A single charger typically houses multiple charging ports.

Operations

Report

The reporting API provides comprehensive data and metrics about your charging network.

Use these endpoints to:

Get real-time status information for all chargers
Generate comprehensive charger reports
View detailed charging session history
Analyze fault data and error conditions
Track energy usage and transactions

These endpoints support filtering by date ranges, chargers, and other parameters to help you generate specific reports for business intelligence, maintenance planning, and usage analytics.

Operations

List Charger Statuses

Request

Retrieves the current operational status of all chargers with detailed port information. Includes counts of chargers in each status category.

Query

chargerstring

Filter by charger UUID

limitinteger

Number of results to return per page

offsetinteger

The initial index from which to return the results

curl -i -X GET \
  'https://demo.epiccharging.com/api/external/v1/report/charger-status/?charger=string&limit=0&offset=0' \
  -H 'Token-Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

countintegerrequired

nextstring or null(uri)

previousstring or null(uri)

resultsArray of objects(ExternalAPIReportChargerStatus)required

results[].idstring(uuid)read-only

Unique identifier for the charger

results[].charger_healthstringread-only

Health status of the charger

results[].ocpp_protocol_versionstringread-only

Version of the OCPP protocol

results[].operating_voltagesnumberread-only

Operating voltage

results[].locationstring or nullnon-emptyrequired

Location name

results[].meter_typestringnon-emptyrequired

Type of meter

results[].statusstring

Current status of the charger

Enum"DISABLED""AVAILABLE""STANDBY""CHARGING""OFFLINE""FAULTED""RESERVED""UNAVAILABLE""UNDEFINED""NOT_CHARGING"

results[].portsArray of objects(ExternalAPIReportChargerPort)required

List of ports on this charger

results[].ports[].idstring(uuid)read-only

Unique identifier for the port

results[].ports[].connector_idinteger or null

Connector ID for OCPP

results[].ports[].statusstring

Current status of the port

Enum"DISABLED""AVAILABLE""STANDBY""CHARGING""OFFLINE""FAULTED""RESERVED""UNAVAILABLE""UNDEFINED""NOT_CHARGING"

Response

application/json

{
  "count": 0,
  "next": "http://example.com",
  "previous": "http://example.com",
  "results": [
    { … }
  ]
}

Get Charger Status

Request

Gets the current operational status of a specific charger by ID, including charger health and detailed port information.

Path

idstring(uuid)required

A UUID string identifying this Charger.

curl -i -X GET \
  'https://demo.epiccharging.com/api/external/v1/report/charger-status/{id}/' \
  -H 'Token-Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

idstring(uuid)read-only

Unique identifier for the charger

charger_healthstringread-only

Health status of the charger

ocpp_protocol_versionstringread-only

Version of the OCPP protocol

operating_voltagesnumberread-only

Operating voltage

locationstring or nullnon-emptyrequired

Location name

meter_typestringnon-emptyrequired

Type of meter

statusstring

Current status of the charger

Enum"DISABLED""AVAILABLE""STANDBY""CHARGING""OFFLINE""FAULTED""RESERVED""UNAVAILABLE""UNDEFINED""NOT_CHARGING"

portsArray of objects(ExternalAPIReportChargerPort)required

List of ports on this charger

ports[].idstring(uuid)read-only

Unique identifier for the port

ports[].connector_idinteger or null

Connector ID for OCPP

ports[].statusstring

Current status of the port

Enum"DISABLED""AVAILABLE""STANDBY""CHARGING""OFFLINE""FAULTED""RESERVED""UNAVAILABLE""UNDEFINED""NOT_CHARGING"

Response

application/json

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "charger_health": "string",
  "ocpp_protocol_version": "string",
  "operating_voltages": 0,
  "location": "string",
  "meter_type": "string",
  "status": "DISABLED",
  "ports": [
    { … }
  ]
}

List Charger Reports

Request

Generates a comprehensive report of all chargers with detailed information including location, owner, commission date, and total power usage. Supports pagination with a default limit of 100 records.

Query

limitinteger

Number of results to return per page

offsetinteger

The initial index from which to return the results

curl -i -X GET \
  'https://demo.epiccharging.com/api/external/v1/report/charger/?limit=0&offset=0' \
  -H 'Token-Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

countintegerrequired

nextstring or null(uri)

previousstring or null(uri)

resultsArray of objects(ReportCharger)required

results[].tenantstringnon-emptyrequired

Tenant name

results[].charger_idstringnon-emptyrequired

Charger identifier

results[].charger_namestringnon-emptyrequired

Name of the charger

results[].site_namestringnon-emptyrequired

Name of the site

results[].addressstringread-only

Physical address

results[].citystringread-only

City

results[].statestringread-only

State or province

results[].zipstringread-only

ZIP or postal code

results[].countrystringread-only

Country

results[].ownerstringread-only

Owner of the charger

results[].utilitystringread-only

Utility provider

results[].commission_datestring(date-time)required

Date when the charger was commissioned

results[].operating_statusstringread-only

Current operating status

results[].total_powernumberread-only

Total power consumption

results[].report_datestring(date-time)required

Date of the report

results[].driver_emailsArray of strings(email)required

Email addresses of drivers

Response

application/json

{
  "count": 0,
  "next": "http://example.com",
  "previous": "http://example.com",
  "results": [
    { … }
  ]
}

List Charging Sessions

Request

Provides a detailed report of all completed charging sessions including timestamps, energy delivered, and associated costs. Supports filtering by date ranges and pagination.

Query

plug_in_start_datetime__gtestring

Filter by plug-in start time (minimum)

plug_in_start_datetime__ltestring

Filter by plug-in start time (maximum)

limitinteger

Number of results to return per page

offsetinteger

The initial index from which to return the results

curl -i -X GET \
  'https://demo.epiccharging.com/api/external/v1/report/charging-session/?limit=0&offset=0&plug_in_start_datetime__gte=string&plug_in_start_datetime__lte=string' \
  -H 'Token-Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

countintegerrequired

nextstring or null(uri)

previousstring or null(uri)

resultsArray of objects(ReportChargingSession)required

results[].tenantstringnon-emptyrequired

Tenant name

results[].session_idstringnon-emptyrequired

Unique identifier for the session

results[].charger_idstringread-only

Charger identifier

results[].port_idstringread-only

Port identifier

results[].charger_manufacturerstringread-only

Manufacturer of the charger

results[].charger_modelstringread-only

Model of the charger

results[].charger_namestringread-only

Name of the charger

results[].plug_in_start_datetimestring(date-time)required

When vehicle was plugged in

results[].plug_in_end_datetimestring(date-time)required

When vehicle was unplugged

results[].charging_start_datetimestring(date-time)required

When charging started

results[].charging_end_datetimestring(date-time)required

When charging ended

results[].charging_timeintegerread-only

Duration of charging in minutes

results[].energy_delivered_to_electric_vehicle_kwhnumberread-only

Energy delivered in kWh

results[].cost_per_session_usdnumberread-only

Cost of the session in USD

results[].driver_emailsArray of strings(email)required

Email addresses of drivers

Response

application/json

{
  "count": 0,
  "next": "http://example.com",
  "previous": "http://example.com",
  "results": [
    { … }
  ]
}

List Faults

Request

Lists all system fault events with detailed error information, categorized by charger. Supports filtering by charger ID and date range, with pagination.

Query

created_at__rangestring

Filter by creation date range

created_at__gtestring

Filter by creation date (minimum)

created_at__ltestring

Filter by creation date (maximum)

chargerstring

Filter by charger UUID

limitinteger

Number of results to return per page

offsetinteger

The initial index from which to return the results

curl -i -X GET \
  'https://demo.epiccharging.com/api/external/v1/report/faults/?charger=string&created_at__gte=string&created_at__lte=string&created_at__range=string&limit=0&offset=0' \
  -H 'Token-Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

countintegerrequired

nextstring or null(uri)

previousstring or null(uri)

resultsArray of objects(ReportFaults)required

results[].chargerstringread-only

Charger identifier

results[].charger_idstringread-only

Charger ID

results[].created_atstring(date-time)read-only

When the fault was created

results[].error_codestringread-only

Error code

results[].error_infostringread-only

Detailed error information

results[].statusstringread-only

Current status

Response

application/json

{
  "count": 0,
  "next": "http://example.com",
  "previous": "http://example.com",
  "results": [
    { … }
  ]
}

List Transactions

Request

Generates a transaction report with detailed charging session information including timestamps, energy usage, and charging duration. Supports filtering by charger, date range, and timestamps.

Query

start_datetime__gtestring

Filter by start date (minimum)

start_datetime__ltestring

Filter by start date (maximum)

stop_datetime__gtestring

Filter by stop date (minimum)

stop_datetime__ltestring

Filter by stop date (maximum)

charger__instring

Filter by charger UUID (comma-separated list)

limitinteger

Number of results to return per page

offsetinteger

The initial index from which to return the results

curl -i -X GET \
  'https://demo.epiccharging.com/api/external/v1/report/transaction/?charger__in=string&limit=0&offset=0&start_datetime__gte=string&start_datetime__lte=string&stop_datetime__gte=string&stop_datetime__lte=string' \
  -H 'Token-Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

countintegerrequired

nextstring or null(uri)

previousstring or null(uri)

resultsArray of objects(ReportTransaction)required

results[].idstring(uuid)read-only

Unique identifier for the transaction

results[].chargerstring(uuid)required

Charger UUID

results[].charger_namestringnon-emptyrequired

Name of the charger

results[].charger_idstringnon-emptyrequired

Charger identifier

results[].plug_in_datetimestring(date-time)required

When vehicle was plugged in

results[].start_datetimestring(date-time)required

When charging started

results[].stop_datetimestring(date-time)required

When charging stopped

results[].timezonestringnon-emptyrequired

Timezone

results[].total_energy_importednumberread-only

Total energy imported in kWh

results[].power_unitsstringread-only

Units of power measurement

Response

application/json

{
  "count": 0,
  "next": "http://example.com",
  "previous": "http://example.com",
  "results": [
    { … }
  ]
}

User

The User API allows you to manage and retrieve information about system users.

These endpoints enable you to:

List all users with access to your charging network
View user details including attached ID tags and accessible chargers
See authorization levels and access rights

User management is essential for controlling access to chargers and tracking usage patterns across your charging infrastructure.

Operations

Epic-Charging Server Application Report API (v1)

Epic-Charging API

Getting Started

Base URL

Authentication

Rate Limiting

Error Responses

Charger Port

Charger

Report

List Charger Statuses

Request

Responses

Was this helpful?

Get Charger Status

Request

Responses

Was this helpful?

List Charger Reports

Request

Responses

Was this helpful?

List Charging Sessions

Request

Responses

Was this helpful?

List Faults

Request

Responses

Was this helpful?

List Transactions

Request

Responses

Was this helpful?

User