Locations along a route

GET

https://api.ocpplab.io/emsp/locations/route

GET

/emsp/locations/route

import { OcpplabSDK } from "ocpplab";
async function main() {
    const client = new OcpplabSDK({
        token: "YOUR_TOKEN_HERE",
    });
    await client.emsp.locations.route({
        polyline: "_p~iF~ps|U_ulLnnqC_mqNvxq`@",
        buffer_km: 2,
        min_power: 50,
    });
}
main();

{
  "data": [
    {
      "uid": "3f2b8c1d-6e4a-4b7f-9c2d-8a1e5f0b7c34",
      "country_code": "NL",
      "party_id": "ABC",
      "location_id": "LOC-AMS-001",
      "source": "PARTNER_OCPI",
      "evse_count": 4,
      "available_count": 3,
      "connector_standards": [
        "IEC_62196_T2_COMBO"
      ],
      "tariff_ids": [
        "TARIFF-DC-FAST"
      ],
      "name": "Amsterdam Zuid",
      "address": "Strawinskylaan 1",
      "city": "Amsterdam",
      "country": "NLD",
      "latitude": 52.338,
      "longitude": 4.872,
      "max_power_kw": 150
    }
  ]
}

Locations within buffer_km of an encoded polyline (Google format, precision 5), in order along the route. Same filters as the map. Returns at most limit locations with no next page: shorten the route or buffer_km to narrow it.

Authentication

AuthorizationBearer

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

Query parameters

connector_typeslist of stringsOptional

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

cpo_idslist of stringsOptional

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

polylinestringRequired4-60000 characters

The route as a Google encoded polyline, precision 5.

buffer_kmdoubleOptional<=20Defaults to 2

Distance from the route in km (default 2, max 20).

limitintegerOptional1-200Defaults to 50

Maximum results (default 50, max 200).

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.

min_powerdouble or nullOptional0-2147483.647

Minimum connector power in kW.

available_onlybooleanOptionalDefaults to false

Only locations with an EVSE free right now.

ownboolean or nullOptional

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

Response

Locations near the route, in order along it.

datalist of objects

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