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
Languages
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

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