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

List Charger Ports

Request

Retrieves a list of all charger ports with their current status and connector information.

This endpoint supports filtering by parameters like status and charger.

Permissions

Requires a valid API key with read permissions for charger ports.

Query

charger__payment_typestring

Filter by payment type (Paid or Free)

Enum"Paid""Free"

chargerstring

Filter by specific charger UUID

status__instring

Filter by charger port status (comma-separated list)

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

location__instring

Filter by location (comma-separated list)

orderingstring

Field to order results by (prefix with - for descending order)

Enum"created_at""-created_at""custom_id""-custom_id""status""-status""parking_lot""-parking_lot""temperature""-temperature"

searchstring

A search term.

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/charger-port/?charger=string&charger__payment_type=Paid&limit=0&location__in=string&offset=0&ordering=created_at&search=string&status__in=DISABLED' \
  -H 'Token-Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

countintegerrequired

nextstring or null(uri)

previousstring or null(uri)

resultsArray of objects(ChargerPortList)required

results[].idstring(uuid)read-only

Unique identifier for the charger port

results[].max_powernumberrequired

Maximum power output in kW

results[].charging_speednumberread-only

Current charging speed

results[].custom_idstringread-only

Custom identifier for the port

results[].powernumber or nullrequired

Current power output

results[].manufacturerobjectread-only

results[].modelobjectread-only

results[].statusobjectread-only

results[].parking_lotobject(ParkingLotLookup)

results[].connector_typestring

Type of connector

Enum"J1772""CCS""CHADEMO""NACS""SHUKO""TYPE_2"

results[].current_amperenumber

Current in amperes

results[].current_kilowatt_hournumber

Current in kilowatt-hours

results[].start_charging_atstring or null(date-time)

When charging started

results[].end_charging_atstring or null(date-time)

When charging ended

results[].chargerstring or null(uuid)required

Associated charger UUID

Response

application/json

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    { … }
  ]
}

Get Charger Port Details

Request

Gets detailed information about a specific charger port by ID, including connector specifications and active session details. Requires a valid API key.

Path

idstring(uuid)required

A UUID string identifying this Charger Port.

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

Responses

Success

Bodyapplication/json

idstring(uuid)read-only

Unique identifier for the charger port

max_powernumberrequired

Maximum power output in kW

charging_speednumberread-only

Current charging speed

custom_idstringread-only

Custom identifier for the port

powernumber or nullrequired

Current power output

manufacturerobjectread-only

modelobjectread-only

statusobjectread-only

parking_lotobject(ParkingLotLookup)

connector_typestring

Enum"J1772""CCS""CHADEMO""NACS""SHUKO""TYPE_2"

chargerstring or null(uuid)required

Associated charger UUID

Response

application/json

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "max_power": 0,
  "charging_speed": 0,
  "custom_id": "string",
  "power": 0,
  "manufacturer": {
    "custom_id": "string",
    "value": "string"
  },
  "model": {
    "custom_id": "string",
    "value": "string",
    "port_count": 0
  },
  "status": {
    "key": "string",
    "value": "string"
  },
  "parking_lot": {
    "id": 0,
    "value": "string"
  },
  "connector_type": "J1772",
  "charger": "703811a5-9055-4273-a9e2-3bd2f3ed85cc"
}

Update Charger Port

Request

Updates specific fields of a charger port, such as status or configuration settings. Requires a valid API key.

Path

idstring(uuid)required

A UUID string identifying this Charger Port.

Bodyapplication/jsonrequired

charging_speednumberrequired

Charging speed to set

custom_idstring or null<= 255 characters

Custom identifier for the port

max_powernumberrequired

Maximum power output

is_deletedboolean

Whether the port is deleted

curl -i -X PATCH \
  'https://demo.epiccharging.com/api/external/v1/charger-port/{id}/' \
  -H 'Content-Type: application/json' \
  -H 'Token-Authorization: YOUR_API_KEY_HERE' \
  -d '{
    "charging_speed": 0,
    "custom_id": "string",
    "max_power": 0,
    "is_deleted": true
  }'

Responses

Success

Bodyapplication/json

charging_speednumberrequired

Charging speed to set

custom_idstring or null<= 255 characters

Custom identifier for the port

max_powernumberrequired

Maximum power output

is_deletedboolean

Whether the port is deleted

Response

application/json

{
  "charging_speed": 0,
  "custom_id": "string",
  "max_power": 0,
  "is_deleted": true
}

Cancel Reservation

Request

Cancels the reservation for charger port. The reservation_id must be provided.

Path

idstring(uuid)required

A UUID string identifying this Charger Port.

Bodyapplication/jsonrequired

reservation_idintegerrequired

Reservation identifier.

curl -i -X PATCH \
  'https://demo.epiccharging.com/api/external/v1/charger-port/{id}/cancel_reservation/' \
  -H 'Content-Type: application/json' \
  -H 'Token-Authorization: YOUR_API_KEY_HERE' \
  -d '{
    "reservation_id": 0
  }'

Responses

Success

Bodyapplication/json

resultstring

Response

application/json

{
  "result": "string"
}

Reserve Charger Port

Request

Reserves a charger port. The fields expiry_date_time, id_tag, and reservation_id must be included in the request body.

Path

idstring(uuid)required

A UUID string identifying this Charger Port.

Bodyapplication/jsonrequired

expiry_date_timestring(date-time)required

Reservation expiry time in UTC format.

id_tagstringrequired

Identification tag.

parent_id_tagstring

Parent Identification tag.

Default "SYS00TEM"

reservation_idintegerrequired

Reservation ID.

curl -i -X PATCH \
  'https://demo.epiccharging.com/api/external/v1/charger-port/{id}/reserve_now/' \
  -H 'Content-Type: application/json' \
  -H 'Token-Authorization: YOUR_API_KEY_HERE' \
  -d '{
    "expiry_date_time": "2019-08-24T14:15:22Z",
    "id_tag": "string",
    "parent_id_tag": "SYS00TEM",
    "reservation_id": 0
  }'

Responses

Success

Bodyapplication/json

resultstring

Response

application/json

{
  "result": "string"
}

Start Charging

Request

Start a charger port to begin charging.

Path

idstring(uuid)required

A UUID string identifying this Charger Port.

Bodyapplication/jsonrequired

object

curl -i -X PATCH \
  'https://demo.epiccharging.com/api/external/v1/charger-port/{id}/start/' \
  -H 'Content-Type: application/json' \
  -H 'Token-Authorization: YOUR_API_KEY_HERE' \
  -d '{}'

Responses

Success

Bodyapplication/json

resultstring

Response

application/json

{
  "result": "string"
}

Stop Charging

Request

Stop a charger port to end charging.

Path

idstring(uuid)required

A UUID string identifying this Charger Port.

Bodyapplication/jsonrequired

object

curl -i -X PATCH \
  'https://demo.epiccharging.com/api/external/v1/charger-port/{id}/stop/' \
  -H 'Content-Type: application/json' \
  -H 'Token-Authorization: YOUR_API_KEY_HERE' \
  -d '{}'

Responses

Success

Bodyapplication/json

resultstring

Response

application/json

{
  "result": "string"
}

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

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

List Charger Ports

Request

Permissions

Responses

Was this helpful?

Get Charger Port Details

Request

Responses

Was this helpful?

Update Charger Port

Request

Responses

Was this helpful?

Cancel Reservation

Request

Responses

Was this helpful?

Reserve Charger Port

Request

Responses

Was this helpful?

Start Charging

Request

Responses

Was this helpful?

Stop Charging

Request

Responses

Was this helpful?

Charger

Report

User