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.
Each filter is a string formatted as:
CLASS.FIELD OPERATOR VALUEOr with an action:
CLASS.FIELD OPERATOR VALUE -> ACTION_KEY=ACTION_VALUE;Multiple filters can be joined with || (logical OR).
| Class | Description |
|---|---|
pool | Refers to the pool (group of charging points) |
station | Refers to the charging station |
chargingPoint | Refers to individual charging points |
vehicleAccess | Refers to access constraints (height, weight) |
| Operator | Meaning |
|---|---|
== | Equals |
!= | Not equals |
<, >, <=, >= | Numeric comparisons |
IN | Match one of multiple values (separated by ;) |
/= /.../ | Regex (supports /i for case-insensitive) |
By default, filters are exclusion rules. To modify behavior, use actions:
| Action Key | Description |
|---|---|
prefCoeff | Preference 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;"[
"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;"
]available(boolean)accessibilityaddressComplementavailabilityStatusavailabilityUntilbrandcommentcountryCodecustomerIddbIdfloorNumberidmaxNominalPowernamenumberOfChargingPointnumberOfParkingSpaceopen24x7operatorIdphoneNumberproviderNamereliabilityScoresiteCategorysiteTypesourceProvidertagsupdateDate
available(boolean)freeCharging(boolean)creditCardPayment(boolean)chargePass(string)rfidAuth(boolean)appAuth(boolean)authenticationInformationauthenticationModesavailabilityStatusbookablefloorNumberidoperatorIdpaymentInformationpaymentModestags
available(boolean)ampereavailabilityStatusavailabilityUntilbusyStatuschargingSpeedcurrencycurrentTypeidnominalPoweroperatorIdremoteChargingtagsusabilityStatusvoltage
maxHeightmaxLengthmaxWeightmaxWidth
๐ For real-world examples and advanced use cases, refer to the dedicated "filters" tutorial.