Skip to navigation

Search locations

Your own OCPP chargers and roaming CPOs’ locations, filtered by area, text, CPO, connector, power, facilities and parking type, optionally scoped to a network or a token group’s networks. Each row carries a stable uid and its source (OWN_OCPP or PARTNER_OCPI).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

cpo_idslist of stringsOptional

Only these CPOs, as CC*PID. Repeat for more than one.

countrieslist of stringsOptional

ISO 3166-1 alpha-3 countries, e.g. NLD. Repeat for more than one.

connector_typeslist of stringsOptional

Only these OCPI connector standards, e.g. IEC_62196_T2. Repeat for more than one.

facilitieslist of stringsOptional

OCPI facilities, e.g. CAFE. A location must list every one. Repeat for more than one.

parking_typeslist of stringsOptional

OCPI parking types, e.g. PARKING_GARAGE. Any one matches. Repeat for more than one.

network_idinteger or nullOptional>=1

Only locations this network reaches. Not together with token_group_id.

token_group_idinteger or nullOptional>=1

Only locations the group’s networks reach. Not together with network_id.

bounding_boxstring or nullOptionalformat: "^-?\d+(\.\d+)?(,-?\d+(\.\d+)?){3}$"

Only locations inside min_lon,min_lat,max_lon,max_lat (WGS84).

afterstring or nullOptionalformat: "^[A-Z]{2}:[A-Z0-9]{3}:.{1,39}$"

Cursor: the previous page’s pagination.end_cursor (country_code:party_id:location_id). Omit it for the first page.

limitintegerOptional1-200Defaults to 50

Maximum rows per page (default 50, max 200).

qstring or nullOptional1-100 characters
Text in name, address or city.
latdouble or nullOptional-90-90

Search centre latitude (WGS84); send with lon.

londouble or nullOptional-180-180

Search centre longitude (WGS84); send with lat.

radius_kmdouble or nullOptional

Search radius around lat/lon in km (default 10).

availabilitybooleanOptionalDefaults to false
Only locations with an EVSE free right now.
min_powerdouble or nullOptional0-2147483.647
Minimum connector power in kW.
ownboolean or nullOptional

true: only your own OCPP chargers. false: only partner (roaming) locations.

Response

One page of own and partner locations.
datalist of objects
paginationobject

Spirii cursor page. Pass end_cursor as the next after value.

Errors

400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
429
Too Many Requests Error
502
Bad Gateway Error
504
Gateway Timeout Error