Skip to content
Last updated

๐Ÿ“˜ Charging Station Filter โ€“ Glossary

This glossary defines how to use the filters parameter in the Charging Station API (v1.0.0). Filters allow advanced selection and prioritization of charging stations.


๐Ÿ” Filter Pattern Syntax

Each filter is a string formatted as:

CLASS.FIELD OPERATOR VALUE

Or with an action:

CLASS.FIELD OPERATOR VALUE -> ACTION_KEY=ACTION_VALUE;

Multiple filters can be joined with || (logical OR).


๐Ÿงฑ CLASS

ClassDescription
poolRefers to the pool (group of charging points)
stationRefers to the charging station
chargingPointRefers to individual charging points
vehicleAccessRefers to access constraints (height, weight)

โš™๏ธ OPERATORS

OperatorMeaning
==Equals
!=Not equals
<, >, <=, >=Numeric comparisons
INMatch one of multiple values (separated by ;)
/= /.../Regex (supports /i for case-insensitive)

๐Ÿงช ACTIONS

By default, filters are exclusion rules. To modify behavior, use actions:

Action KeyDescription
prefCoeffPreference coefficient if condition is matched. Values:
- > 1 โ†’ prefer (up to 10)
- < 1 โ†’ avoid (e.g. 0.5 means half-priority)
- 1 โ†’ neutral

๐Ÿง  Example: Boost free charging stations:

"station.freeCharging==true -> prefCoeff=7.0;"

๐Ÿงพ Examples

[
  "pool.brand /= /Izivia|IONITY.*/ || pool.brand == Tesla",
  "station.available == true",
  "chargingPoint.nominalPower >= 7",
  "chargingPoint.currency IN EUR;GBP;DKK",
  "station.freeCharging==true -> prefCoeff=7.0;"
]

โœ… Supported Filter Fields

๐Ÿข Pool Filters

  • available (boolean)
  • accessibility
  • addressComplement
  • availabilityStatus
  • availabilityUntil
  • brand
  • comment
  • countryCode
  • customerId
  • dbId
  • floorNumber
  • id
  • maxNominalPower
  • name
  • numberOfChargingPoint
  • numberOfParkingSpace
  • open24x7
  • operatorId
  • phoneNumber
  • providerName
  • reliabilityScore
  • siteCategory
  • siteType
  • sourceProvider
  • tags
  • updateDate

๐Ÿช Station Filters

  • available (boolean)
  • freeCharging (boolean)
  • creditCardPayment (boolean)
  • chargePass (string)
  • rfidAuth (boolean)
  • appAuth (boolean)
  • authenticationInformation
  • authenticationModes
  • availabilityStatus
  • bookable
  • floorNumber
  • id
  • operatorId
  • paymentInformation
  • paymentModes
  • tags

โšก Charging Point Filters

  • available (boolean)
  • ampere
  • availabilityStatus
  • availabilityUntil
  • busyStatus
  • chargingSpeed
  • currency
  • currentType
  • id
  • nominalPower
  • operatorId
  • remoteCharging
  • tags
  • usabilityStatus
  • voltage

๐Ÿš— Vehicle Access Filters

  • maxHeight
  • maxLength
  • maxWeight
  • maxWidth

๐Ÿ“Œ For real-world examples and advanced use cases, refer to the dedicated "filters" tutorial.