Reference · built on requestConnectorEnergy, EV & distributed resources

ChargePoint Web Services API

Station status, charging sessions, group load, and alarms from ChargePoint's SOAP Web Services API, with shedLoad for control.

About

ChargePoint operates a network of Level 2 and DC fast charging stations owned by workplaces, fleets, property owners, and municipalities. Its Web Services API is a SOAP service, described by a WSDL and reached at webservices.chargepoint.com/webservices/chargepoint/services/5.1, that an organization's own administrators use to read station status, session data, and group load, and to shed load on stations and ports.

Through Fibric, an operator watches the load on a station group against a site limit and, when the building approaches its demand threshold, proposes a shedLoad call with an allowed load per station or a percent reduction. You approve. The call is made once and a receipt records the values and when clearShedState restored them.

This is a reference listing. It documents what Fibric would read from ChargePoint Web Services API and what it could propose, based on the vendor's published interfaces. Fibric builds it under a managed deployment when you request it; selecting it here installs nothing.

Inputs

  • Stations and their ports through getStations, and network and port status through getStationStatus, paged with startRecord and moreFlag
  • Charging sessions through getChargingSessionData and get15minChargingSessionData, with sessionID, energy, start and end time, durations, userID, and endedBy
  • Load per station group, station, and port through getLoad, returning sgLoad and each station's stationLoad
  • Alarms and active faults through getAlarms and getStationActiveFaults, with alarmType, alarmTime, and station serial number
  • Organizations, station groups, station rights, and users through getOrgsAndStationGroups, getStationGroups, getStationRights, and getUsers
  • Transactions, fleet vehicles, and fleet usage through getTransactionData, getFleetVehicles, and getFleetUsageData

Proposed actions

  • Target capability: propose a load reduction through shedLoad, by allowedLoadPerStation or percentShedPerStation for a group, station, or port, with a timeInterval
  • Target capability: propose restoring full load through clearShedState
  • Target capability: propose a scheduled load-shed event through createLoadShedEvent with eventStartTime, eventDuration, and allowOptOut, or cancel one through removeLoadShedEvent
  • Target capability: propose clearing station alarms through clearAlarms once a fault is resolved
  • Target capability: propose notifying a waitlisted driver through setWaitlistDone

Proposed actions are target capabilities. Every action runs propose-first and needs a validated deployment and the appropriate permissions.

What you can build

  • Shed charger load before a demand peak

    As the building meter climbs toward its monthly peak, the operator proposes shedLoad on the parking-garage station group with a percent reduction and a time interval. You approve; clearShedState follows automatically.

    With Peak Demand, Charge Balancing

  • Keep fleet vehicles charged for the morning run

    Reading sessions and fleet vehicle records overnight, the operator flags vehicles that stopped charging early and drafts the depot list of ports to check before dispatch.

    With Depot Charging, Charge Readiness

  • Route a station fault to facilities

    A new entry from getStationActiveFaults becomes a proposed work order with the station serial number and alarm time. After the fix, the operator proposes clearAlarms.

    With Alarm Triage, Predictive Maintenance

Requirements

  • An organization that owns ChargePoint stations, with a service plan and a Network Manager who can add admins
  • An admin created with the API User role under Organizations, Admins, who then downloads the Programmer's Reference Guide and WSDL from Help, API Docs
  • The API License Key and a generated password from Organizations, API Info; regenerating the password retires the old one
  • TLS 1.2 or later for every connection to the service endpoint
Authentication
WS-Security UsernameToken in the SOAP header of every message, carrying the organization's API License Key as the username and a password generated under Organizations, API Info.

Limits

  • SOAP and XML only; there is no JSON or REST interface, and the setup guide documents no webhook delivery
  • Full method semantics are documented only in the Programmer's Reference Guide, which requires a login to the ChargePoint dashboard
  • Percent shed values are bounded to 0 through 100, and shed state persists until clearShedState is called or the timeInterval ends
  • Results come back in pages; the connector loops on moreFlag and startRecord to read a full fleet

Access and pricing

Reference listing. Fibric builds the connector under a managed deployment when you request it. Your quote covers the build, capabilities, usage, and support.

Request ChargePoint Web Services API ↗

Questions and answers

Is this a REST API?
No. ChargePoint's Web Services API is SOAP over HTTPS, defined by a WSDL at webservices.chargepoint.com. Every message carries a WS-Security UsernameToken header with the API License Key and password. The connector builds and parses the SOAP envelopes on your behalf.
How does load shedding work?
shedLoad targets a station group, a single station, or a port, and takes either an allowed load or a percent to shed between 0 and 100, with a time interval. clearShedState lifts it. createLoadShedEvent schedules the same for a start time and duration, optionally letting drivers opt out.
Where do the credentials come from?
From the ChargePoint dashboard. A Network Manager adds an admin with the API User role, and Organizations, API Info shows the API License Key and generates a password. ChargePoint notes that generating a new password makes the old one obsolete, so existing calls must be updated.
Ask about ChargePoint Web Services API

Ask about the capabilities and requirements in this listing.

For project-specific requirements, contact Fibric.