Skip to main content
GET
Map clustering

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

token_id
string

End-user token id; resolves through its token group to the reachable SUB networks.

token_group_id
string

Token group id (peer to token_id); resolves to its assigned SUB networks.

start_charging_capability
enum<string>

Keep only locations with an EVSE usable with this start-charging method. RFID matches a location with at least one EVSE exposing an RFID reader; APP matches one with an EVSE that can be remote-started. Existential (any EVSE) and availability-agnostic (occupied or faulted EVSEs still count).

Available options:
RFID,
APP
vehicle_types
enum<string>[]

Keep only locations with an EVSE that fits any of these vehicle types. Values are the OCPI VehicleType enum. Matches a location with at least one EVSE advertising ANY listed value (multi-value is OR). Existential (any EVSE) and availability-agnostic (occupied or faulted EVSEs still count).

Available options:
MOTORCYCLE,
PERSONAL_VEHICLE,
PERSONAL_VEHICLE_WITH_TRAILER,
VAN,
SEMI_TRACTOR,
RIGID,
TRUCK_WITH_TRAILER,
BUS,
DISABLED
bounding_box
string
required

Viewport as SW_lat,SW_lng,NE_lat,NE_lng (south-west then north-east corner).

Example:

"55.6,12.5,55.7,12.6"

zoom_level
number
default:12

Zoom level for clustering granularity (1-20, default 12).

Required range: 1 <= x <= 20

Response

Location clusters for the requested map viewport and zoom level.

clusters
object[]
required

Location clusters for map display.