Skip to content

Charging On Route

The charging on route feature provides drivers the ability to plan locations where vehicle recharge will be required on the route. The following parameters are used:

  1. Route: list of geo-points of the current route
  2. State of Charge: percentage of charge remaining on vehicle battery
  3. Remaining range: current estimated range of vehicle in Km
  4. Low energy threshold: the lowest percentage of remaining battery charge acceptable before next recharge. This parameter accepts a value of between 5 and 50.

With the above parameters this feature will recommend locations indicating where re-charge is required adjacent to driver’s route. Consider the following cases:

  • Route requires a single stop to charge: Feature will return several EV charge stations in vicinity of the required charging location adjacent to the route.
  • Route requires multiple charging stops: Features returns 2 or more ‘clusters’ of EV charge station locations with each cluster representing a recommend charge location.
  • Route requires no charging stops: If no charging is required then feature will return EV charge stations around the destination. Status code will indicate no charge is required (NO_CHARGING_REQUIRED see status codes table).
  • EV charge stations are not found to support the route: in cases where EV charge stations cannot be found to support any given leg of the route then this feature will not return any charge stations and status code will indicate failure to plan route (FAILED_TO_PLAN_ROUTE see status codes table). Changing filters or low energy threshold parameter may enable more charge stations to be found.

Filtering is supported based on below listed charging station attributes:

Filter by Charge Network This feature enables drivers to find EV charge stations for a specific charging network such as Chargepoint or EVgo. To filter charge station search by network use the .setChargerBrands method within EVFilter.Builder(). The following table shows some common charge networks and their respective ids (for the full list see EV Charging networks table):

ID Charge Network
99100001 ChargePoint
99100002 Blink
99100003 eVgo
99100010 ElectrifyAmerica

Filter by Connector Type This feature enables drivers to find EV charge stations by specific connector type such as J1772, CCS, etc. To filter charge stations by connector type use the .setConnectorTypes method within EVFilter.Builder(). The below table contains examples of commonly used connector types:

ID Connector Type
30001 J1772
30002 SAE Combo
30003 CHAdeMO

Filter by Charge Level This feature enables drivers to find EV charge stations by specific power (charge) level such as Level 2 or DC Fast. To filter stations by charge level use the .setPowerFeedLevels method within EVFilter.Builder(). Currently supported power levels are:

ID Power Level
1 Level 1
2 Level 2
5 DC Fast

Please see the API reference for the main classes related to Charging On Route.

Key methods

Method Details
setLocation(double, double) The current location of the vehicle, which is also the starting point for the route. For example, location=37.1245,-122.45678.
setEvContext(EvContext) Vehicle current energy info, including current energy, current range, low energy threshold
setRoute(List) Route points of the corridor


Sample code

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
List<GeoPoint> route = Arrays.asList(
    new GeoPoint(37.78509, -122.41988),
    new GeoPoint(37.785182, -122.417924),
    new GeoPoint(37.785808, -122.412992),
    new GeoPoint(37.786318, -122.408954),
    new GeoPoint(37.785774, -122.406246),
    new GeoPoint(37.783251, -122.402708),
    new GeoPoint(37.781211, -122.400159),
    new GeoPoint(37.779522, -122.398145),
    new GeoPoint(37.774814, -122.400996),
    new GeoPoint(37.760635, -122.39257),
    new GeoPoint(37.749102, -122.392758),
    new GeoPoint(37.726603, -122.402483),
    new GeoPoint(37.714805, -122.397974),
    new GeoPoint(37.704301, -122.394287),
    new GeoPoint(37.669787, -122.392891),
    new GeoPoint(37.660623, -122.403926),
    new GeoPoint(37.644247, -122.406364),
    new GeoPoint(37.63089, -122.402811),
    new GeoPoint(37.611007, -122.393655),
    new GeoPoint(37.601292, -122.378646),
    new GeoPoint(37.587965, -122.357438),
    new GeoPoint(37.573261, -122.316743),
    new GeoPoint(37.550567, -122.293655),
    new GeoPoint(37.548743, -122.291949),
    new GeoPoint(37.529546, -122.273979),
    new GeoPoint(37.506343, -122.247718),
    new GeoPoint(37.495907, -122.231907),
    new GeoPoint(37.487457, -122.205884),
    new GeoPoint(37.481693, -122.177417),
    new GeoPoint(37.466211, -122.150899),
    new GeoPoint(37.452112, -122.12693),
    new GeoPoint(37.428088, -122.101374),
    new GeoPoint(37.418478, -122.089184),
    new GeoPoint(37.411892, -122.078361),
    new GeoPoint(37.407713, -122.067189),
    new GeoPoint(37.403049, -122.047017),
    new GeoPoint(37.399611, -122.031169),
    new GeoPoint(37.396422, -122.016668),
    new GeoPoint(37.394702, -122.008838),
    new GeoPoint(37.389654, -121.991164),
    new GeoPoint(37.384341, -121.972437),
    new GeoPoint(37.377288, -121.945145),
    new GeoPoint(37.376128, -121.939052),
    new GeoPoint(37.368647, -121.908964),
    new GeoPoint(37.360758, -121.904873),
    new GeoPoint(37.351621, -121.914449),
    new GeoPoint(37.347299, -121.916365),
    new GeoPoint(37.346281, -121.91517),
    new GeoPoint(37.348591, -121.913474)
);

client.chargingOnRouteRequest()
        .setEvContext(EvContext.builder()
                .setLowEnergyThreshold(30)
                .setRemainingRangeInKm(30)
                .setStateOfCharge(40)
                .build())
        .setLocation(37.78509,-122.41988)
        .setRoute(route)
        .asyncCall(new Callback<EvChargingOnRouteResponse>() {

            @Override
            public void onSuccess(EvChargingOnRouteResponse response) {

                for (EvCluster evCluster : response.getResults()) {
                    List<Entity> evEntities = evCluster.getEntities();
                    // ...
                }
            }

            @Override
            public void onFailure(Throwable t) {

            }
        });

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
val route = Arrays.asList(
    GeoPoint(37.78509, -122.41988),
    GeoPoint(37.785182, -122.417924),
    GeoPoint(37.785808, -122.412992),
    GeoPoint(37.786318, -122.408954),
    GeoPoint(37.785774, -122.406246),
    GeoPoint(37.783251, -122.402708),
    GeoPoint(37.781211, -122.400159),
    GeoPoint(37.779522, -122.398145),
    GeoPoint(37.774814, -122.400996),
    GeoPoint(37.760635, -122.39257),
    GeoPoint(37.749102, -122.392758),
    GeoPoint(37.726603, -122.402483),
    GeoPoint(37.714805, -122.397974),
    GeoPoint(37.704301, -122.394287),
    GeoPoint(37.669787, -122.392891),
    GeoPoint(37.660623, -122.403926),
    GeoPoint(37.644247, -122.406364),
    GeoPoint(37.63089, -122.402811),
    GeoPoint(37.611007, -122.393655),
    GeoPoint(37.601292, -122.378646),
    GeoPoint(37.587965, -122.357438),
    GeoPoint(37.573261, -122.316743),
    GeoPoint(37.550567, -122.293655),
    GeoPoint(37.548743, -122.291949),
    GeoPoint(37.529546, -122.273979),
    GeoPoint(37.506343, -122.247718),
    GeoPoint(37.495907, -122.231907),
    GeoPoint(37.487457, -122.205884),
    GeoPoint(37.481693, -122.177417),
    GeoPoint(37.466211, -122.150899),
    GeoPoint(37.452112, -122.12693),
    GeoPoint(37.428088, -122.101374),
    GeoPoint(37.418478, -122.089184),
    GeoPoint(37.411892, -122.078361),
    GeoPoint(37.407713, -122.067189),
    GeoPoint(37.403049, -122.047017),
    GeoPoint(37.399611, -122.031169),
    GeoPoint(37.396422, -122.016668),
    GeoPoint(37.394702, -122.008838),
    GeoPoint(37.389654, -121.991164),
    GeoPoint(37.384341, -121.972437),
    GeoPoint(37.377288, -121.945145),
    GeoPoint(37.376128, -121.939052),
    GeoPoint(37.368647, -121.908964),
    GeoPoint(37.360758, -121.904873),
    GeoPoint(37.351621, -121.914449),
    GeoPoint(37.347299, -121.916365),
    GeoPoint(37.346281, -121.91517),
    GeoPoint(37.348591, -121.913474)
)

client.chargingOnRouteRequest()
    .setEvContext(EvContext.builder()
        .setLowEnergyThreshold(30.0)
        .setRemainingRangeInKm(30.0)
        .setStateOfCharge(40.0)
        .build())
    .setLocation(37.78509, -122.41988)
    .setRoute(route)
    .asyncCall(object : Callback<EvChargingOnRouteResponse> {

        override fun onSuccess(response: EvChargingOnRouteResponse) {

            for (evCluster in response.results) {
                val evEntities = evCluster.entities
                // ...
            }
        }

        override fun onFailure(t: Throwable) {

        }
    })

Response example

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
{
    "code":"SUCCESS",
    "message":"SUCCESS",
    "reference_id":"aab72d11-d11e-4988-b91c-da6af6baf2e3",
    "results":[
        {
            "cluster_number":1,
            "entities":[
                {
                    "id":"P-NOFT-11_MF006",
                    "type":"PLACE",
                    "place":{
                        "name":"Electric Vehicle Charge Station",
                        "phone_numbers":[
                            "6506978397"
                        ],
                        "categories":[
                            {
                                "id":"771",
                                "name":"Electric Charge"
                            }
                        ],
                        "address":{
                            "formatted_address":"460 EL CAMINO REAL, SAN FRANCISCO BAY AREA CA 94030, USA",
                            "house_number":"460",
                            "street":{
                                "body":"EL CAMINO REAL",
                                "formatted_name":"EL CAMINO REAL"
                            },
                            "city":"SAN FRANCISCO BAY AREA",
                            "state":"CA",
                            "country":"USA",
                            "postal_code":"94030",
                            "geo_coordinates":{
                                "latitude":37.603,
                                "longitude":-122.39244
                            },
                            "nav_coordinates":{
                                "latitude":37.603,
                                "longitude":-122.39244
                            },
                            "address_lines":[
                                "460 EL CAMINO REAL",
                                "SAN FRANCISCO BAY AREA CA 94030, USA"
                            ]
                        }
                    },
                    "facets":{
                        "ev_connectors":{
                            "total_number":1,
                            "connector_counts":[
                                {
                                    "level":2,
                                    "total":1
                                }
                            ],
                            "connectors":[
                                {
                                    "connector_type":{
                                        "id":30001,
                                        "name":"J1772"
                                    },
                                    "power_feed_level":{
                                        "level":2,
                                        "name":"Level 2"
                                    },
                                    "connector_number":1,
                                    "charger_brand":{

                                    },
                                    "charger_manufacturer":"WEB",
                                    "customer_connector_name":"AC EV connector (Yazaki - type 1)"
                                }
                            ]
                        },
                        "nearby":{
                            "nearby_categories":[
                                {
                                    "category":{
                                        "id":"226",
                                        "name":"Restaurants"
                                    },
                                    "count":1,
                                    "distance":402.336
                                },
                                {
                                    "category":{
                                        "id":"1620",
                                        "name":"Entertainment"
                                    },
                                    "count":1,
                                    "distance":402.336
                                },
                                {
                                    "category":{
                                        "id":"248",
                                        "name":"Fast Food"
                                    },
                                    "count":1,
                                    "distance":402.336
                                },
                                {
                                    "category":{
                                        "id":"241",
                                        "name":"Coffee Houses"
                                    },
                                    "count":1,
                                    "distance":402.336
                                },
                                {
                                    "category":{
                                        "id":"771",
                                        "name":"Electric Charge"
                                    },
                                    "count":5,
                                    "distance":402.336
                                }
                            ]
                        },
                        "drive_time":{
                            "drive_distance":25600,
                            "drive_duration":1359
                        }
                    }
                },
                {
                    "id":"P-NOFT-2_CHP90309",
                    "type":"PLACE",
                    "place":{
                        "name":"CCSF - SFO / SFO INT LOT G-4",
                        "phone_numbers":[
                            "8887584389"
                        ],
                        "categories":[
                            {
                                "id":"771",
                                "name":"Electric Charge"
                            }
                        ],
                        "address":{
                            "formatted_address":"San Francsico International Airport, SAN FRANCISCO CA 94128, USA",
                            "street":{
                                "body":"San Francsico International Airport",
                                "formatted_name":"San Francsico International Airport"
                            },
                            "city":"SAN FRANCISCO",
                            "state":"CA",
                            "country":"USA",
                            "postal_code":"94128",
                            "geo_coordinates":{
                                "latitude":37.61558,
                                "longitude":-122.39302
                            },
                            "nav_coordinates":{
                                "latitude":37.61558,
                                "longitude":-122.39302
                            },
                            "address_lines":[
                                "San Francsico International Airport",
                                "SAN FRANCISCO CA 94128, USA"
                            ]
                        }
                    },
                    "facets":{
                        "ev_connectors":{
                            "total_number":2,
                            "connector_counts":[
                                {
                                    "level":2,
                                    "total":2
                                }
                            ],
                            "connectors":[
                                {
                                    "connector_type":{
                                        "id":30001,
                                        "name":"J1772"
                                    },
                                    "power_feed_level":{
                                        "level":2,
                                        "name":"Level 2"
                                    },
                                    "connector_number":2,
                                    "charger_brand":{
                                        "brand_id":"99100001",
                                        "brand_name":"ChargePoint"
                                    },
                                    "charger_manufacturer":"ChargePoint",
                                    "customer_connector_name":"AC EV connector (Yazaki - type 1)",
                                    "customer_charge_level":2,
                                    "max_power":6.6
                                }
                            ]
                        },
                        "payment":{
                            "payment_methods":[
                                {
                                    "payment_method_type":"Subscription",
                                    "accept":true,
                                    "supported_vendors":[
                                        "ChargePoint Network"
                                    ]
                                }
                            ]
                        },
                        "nearby":{
                            "nearby_categories":[
                                {
                                    "category":{
                                        "id":"771",
                                        "name":"Electric Charge"
                                    },
                                    "count":3,
                                    "distance":402.336
                                }
                            ]
                        },
                        "drive_time":{
                            "drive_distance":23638,
                            "drive_duration":1383
                        }
                    }
                },
                {
                    "id":"P-NOFT-2_CHP89799",
                    "type":"PLACE",
                    "place":{
                        "name":"CCSF - SFO / SFO INT LOT G-8",
                        "phone_numbers":[
                            "8887584389"
                        ],
                        "categories":[
                            {
                                "id":"771",
                                "name":"Electric Charge"
                            }
                        ],
                        "address":{
                            "formatted_address":"San Francisco International Airport, SAN FRANCISCO CA 94128, USA",
                            "street":{
                                "body":"San Francisco International Airport",
                                "formatted_name":"San Francisco International Airport"
                            },
                            "city":"SAN FRANCISCO",
                            "state":"CA",
                            "country":"USA",
                            "postal_code":"94128",
                            "geo_coordinates":{
                                "latitude":37.61548,
                                "longitude":-122.39299
                            },
                            "nav_coordinates":{
                                "latitude":37.61548,
                                "longitude":-122.39299
                            },
                            "address_lines":[
                                "San Francisco International Airport",
                                "SAN FRANCISCO CA 94128, USA"
                            ]
                        }
                    },
                    "facets":{
                        "ev_connectors":{
                            "total_number":14,
                            "connector_counts":[
                                {
                                    "level":2,
                                    "total":14
                                }
                            ],
                            "connectors":[
                                {
                                    "connector_type":{
                                        "id":30001,
                                        "name":"J1772"
                                    },
                                    "power_feed_level":{
                                        "level":2,
                                        "name":"Level 2"
                                    },
                                    "connector_number":14,
                                    "charger_brand":{
                                        "brand_id":"99100001",
                                        "brand_name":"ChargePoint"
                                    },
                                    "charger_manufacturer":"ChargePoint",
                                    "customer_connector_name":"AC EV connector (Yazaki - type 1)",
                                    "customer_charge_level":2,
                                    "max_power":6.6
                                }
                            ]
                        },
                        "payment":{
                            "payment_methods":[
                                {
                                    "payment_method_type":"Subscription",
                                    "accept":true,
                                    "supported_vendors":[
                                        "ChargePoint Network"
                                    ]
                                }
                            ]
                        },
                        "nearby":{
                            "nearby_categories":[
                                {
                                    "category":{
                                        "id":"771",
                                        "name":"Electric Charge"
                                    },
                                    "count":3,
                                    "distance":402.336
                                }
                            ]
                        },
                        "drive_time":{
                            "drive_distance":23495,
                            "drive_duration":1381
                        }
                    }
                }
            ]
        },
        {
            "cluster_number":2,
            "entities":[
                {
                    "id":"P-NOFT-2_CHP346661",
                    "type":"PLACE",
                    "place":{
                        "name":"FACEBOOK / MPK 57 FC-5",
                        "phone_numbers":[
                            "8887584389"
                        ],
                        "categories":[
                            {
                                "id":"771",
                                "name":"Electric Charge"
                            }
                        ],
                        "address":{
                            "formatted_address":"1350 CA-114, SAN FRANCISCO BAY AREA CA 94025, USA",
                            "house_number":"1350",
                            "street":{
                                "body":"CA-114",
                                "formatted_name":"CA-114"
                            },
                            "city":"SAN FRANCISCO BAY AREA",
                            "state":"CA",
                            "country":"USA",
                            "postal_code":"94025",
                            "geo_coordinates":{
                                "latitude":37.47664,
                                "longitude":-122.15128
                            },
                            "nav_coordinates":{
                                "latitude":37.47664,
                                "longitude":-122.15128
                            },
                            "address_lines":[
                                "1350 CA-114",
                                "SAN FRANCISCO BAY AREA CA 94025, USA"
                            ]
                        }
                    },
                    "facets":{
                        "ev_connectors":{
                            "total_number":6,
                            "connector_counts":[
                                {
                                    "level":5,
                                    "total":6
                                }
                            ],
                            "connectors":[
                                {
                                    "connector_type":{
                                        "id":30002,
                                        "name":"SAE Combo"
                                    },
                                    "power_feed_level":{
                                        "level":5,
                                        "name":"DC Fast"
                                    },
                                    "connector_number":5,
                                    "charger_brand":{
                                        "brand_id":"99100001",
                                        "brand_name":"ChargePoint"
                                    },
                                    "charger_manufacturer":"ChargePoint",
                                    "customer_connector_name":"AC/DC combo (Yazaki - type 1)",
                                    "customer_charge_level":3,
                                    "max_power":50
                                },
                                {
                                    "connector_type":{
                                        "id":30003,
                                        "name":"CHAdeMO"
                                    },
                                    "power_feed_level":{
                                        "level":5,
                                        "name":"DC Fast"
                                    },
                                    "connector_number":1,
                                    "charger_brand":{
                                        "brand_id":"99100001",
                                        "brand_name":"ChargePoint"
                                    },
                                    "charger_manufacturer":"ChargePoint",
                                    "customer_connector_name":"DC TEPCO connector",
                                    "customer_charge_level":3,
                                    "max_power":50
                                }
                            ]
                        },
                        "payment":{
                            "payment_methods":[
                                {
                                    "payment_method_type":"Subscription",
                                    "accept":true,
                                    "supported_vendors":[
                                        "ChargePoint Network"
                                    ]
                                }
                            ]
                        },
                        "nearby":{
                            "nearby_categories":[
                                {
                                    "category":{
                                        "id":"226",
                                        "name":"Restaurants"
                                    },
                                    "count":1,
                                    "distance":402.336
                                },
                                {
                                    "category":{
                                        "id":"248",
                                        "name":"Fast Food"
                                    },
                                    "count":1,
                                    "distance":402.336
                                },
                                {
                                    "category":{
                                        "id":"241",
                                        "name":"Coffee Houses"
                                    },
                                    "count":1,
                                    "distance":402.336
                                },
                                {
                                    "category":{
                                        "id":"771",
                                        "name":"Electric Charge"
                                    },
                                    "count":6,
                                    "distance":402.336
                                }
                            ]
                        },
                        "drive_time":{
                            "drive_distance":51405,
                            "drive_duration":2484
                        }
                    }
                },
                {
                    "id":"P-NOFT-2_CHP329431",
                    "type":"PLACE",
                    "place":{
                        "name":"FACEBOOK / MPK 57 FC-7",
                        "phone_numbers":[
                            "8887584389"
                        ],
                        "categories":[
                            {
                                "id":"771",
                                "name":"Electric Charge"
                            }
                        ],
                        "address":{
                            "formatted_address":"CA-114, MENLO PARK CA 94025, USA",
                            "street":{
                                "body":"CA-114",
                                "formatted_name":"CA-114"
                            },
                            "city":"MENLO PARK",
                            "state":"CA",
                            "country":"USA",
                            "postal_code":"94025",
                            "geo_coordinates":{
                                "latitude":37.47715,
                                "longitude":-122.15213
                            },
                            "nav_coordinates":{
                                "latitude":37.47715,
                                "longitude":-122.15213
                            },
                            "address_lines":[
                                "CA-114",
                                "MENLO PARK CA 94025, USA"
                            ]
                        }
                    },
                    "facets":{
                        "ev_connectors":{
                            "total_number":1,
                            "connector_counts":[
                                {
                                    "level":5,
                                    "total":1
                                }
                            ],
                            "connectors":[
                                {
                                    "connector_type":{
                                        "id":30002,
                                        "name":"SAE Combo"
                                    },
                                    "power_feed_level":{
                                        "level":5,
                                        "name":"DC Fast"
                                    },
                                    "connector_number":1,
                                    "charger_brand":{
                                        "brand_id":"99100001",
                                        "brand_name":"ChargePoint"
                                    },
                                    "charger_manufacturer":"ChargePoint",
                                    "customer_connector_name":"AC/DC combo (Yazaki - type 1)",
                                    "customer_charge_level":3,
                                    "max_power":50
                                }
                            ]
                        },
                        "payment":{
                            "payment_methods":[
                                {
                                    "payment_method_type":"Subscription",
                                    "accept":true,
                                    "supported_vendors":[
                                        "ChargePoint Network"
                                    ]
                                }
                            ]
                        },
                        "nearby":{
                            "nearby_categories":[
                                {
                                    "category":{
                                        "id":"226",
                                        "name":"Restaurants"
                                    },
                                    "count":1,
                                    "distance":402.336
                                },
                                {
                                    "category":{
                                        "id":"248",
                                        "name":"Fast Food"
                                    },
                                    "count":1,
                                    "distance":402.336
                                },
                                {
                                    "category":{
                                        "id":"241",
                                        "name":"Coffee Houses"
                                    },
                                    "count":1,
                                    "distance":402.336
                                },
                                {
                                    "category":{
                                        "id":"771",
                                        "name":"Electric Charge"
                                    },
                                    "count":6,
                                    "distance":402.336
                                }
                            ]
                        },
                        "drive_time":{
                            "drive_distance":51352,
                            "drive_duration":2457
                        }
                    }
                },
                {
                    "id":"P-NOFT-2_CHP88701",
                    "type":"PLACE",
                    "place":{
                        "name":"FACEBOOK / MPK 17-10",
                        "phone_numbers":[
                            "8887584389"
                        ],
                        "categories":[
                            {
                                "id":"771",
                                "name":"Electric Charge"
                            }
                        ],
                        "address":{
                            "formatted_address":"HACKER WAY, SAN FRANCISCO BAY AREA CA 94025, USA",
                            "street":{
                                "body":"HACKER WAY",
                                "formatted_name":"HACKER WAY"
                            },
                            "city":"SAN FRANCISCO BAY AREA",
                            "state":"CA",
                            "country":"USA",
                            "postal_code":"94025",
                            "geo_coordinates":{
                                "latitude":37.48495,
                                "longitude":-122.1459
                            },
                            "nav_coordinates":{
                                "latitude":37.48495,
                                "longitude":-122.1459
                            },
                            "address_lines":[
                                "HACKER WAY",
                                "SAN FRANCISCO BAY AREA CA 94025, USA"
                            ]
                        }
                    },
                    "facets":{
                        "ev_connectors":{
                            "total_number":5,
                            "connector_counts":[
                                {
                                    "level":2,
                                    "total":4
                                },
                                {
                                    "level":5,
                                    "total":1
                                }
                            ],
                            "connectors":[
                                {
                                    "connector_type":{
                                        "id":30001,
                                        "name":"J1772"
                                    },
                                    "power_feed_level":{
                                        "level":2,
                                        "name":"Level 2"
                                    },
                                    "connector_number":4,
                                    "charger_brand":{
                                        "brand_id":"99100001",
                                        "brand_name":"ChargePoint"
                                    },
                                    "charger_manufacturer":"ChargePoint",
                                    "customer_connector_name":"AC EV connector (Yazaki - type 1)",
                                    "customer_charge_level":2,
                                    "max_power":6.6
                                },
                                {
                                    "connector_type":{
                                        "id":30003,
                                        "name":"CHAdeMO"
                                    },
                                    "power_feed_level":{
                                        "level":5,
                                        "name":"DC Fast"
                                    },
                                    "connector_number":1,
                                    "charger_brand":{
                                        "brand_id":"99100001",
                                        "brand_name":"ChargePoint"
                                    },
                                    "charger_manufacturer":"ChargePoint",
                                    "customer_connector_name":"DC TEPCO connector",
                                    "customer_charge_level":3,
                                    "max_power":50
                                }
                            ]
                        },
                        "payment":{
                            "payment_methods":[
                                {
                                    "payment_method_type":"Subscription",
                                    "accept":true,
                                    "supported_vendors":[
                                        "ChargePoint Network"
                                    ]
                                }
                            ]
                        },
                        "nearby":{
                            "nearby_categories":[
                                {
                                    "category":{
                                        "id":"771",
                                        "name":"Electric Charge"
                                    },
                                    "count":16,
                                    "distance":402.336
                                }
                            ]
                        },
                        "drive_time":{
                            "drive_distance":51161,
                            "drive_duration":2604
                        }
                    }
                }
            ]
        }
    ],
    "response_time":226,
    "response_type":"CLOUD"
}

Search With Filters

Key methods

Method Details
setLocation(double, double) The current location of the vehicle, which is also the starting point for the route. For example, location=37.1245,-122.45678.
setEvContext(EvContext) Vehicle current energy info, including current energy, current range, low energy threshold
setRoute(List) Route points of the corridor
setEvFilter(EvFilter) Charging station filter properties


Sample code

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
List<GeoPoint> route = Arrays.asList(
    new GeoPoint(37.78509, -122.41988),
    new GeoPoint(37.785182, -122.417924),
    new GeoPoint(37.785808, -122.412992),
    new GeoPoint(37.786318, -122.408954),
    new GeoPoint(37.785774, -122.406246),
    new GeoPoint(37.783251, -122.402708),
    new GeoPoint(37.781211, -122.400159),
    new GeoPoint(37.779522, -122.398145),
    new GeoPoint(37.774814, -122.400996),
    new GeoPoint(37.760635, -122.39257),
    new GeoPoint(37.749102, -122.392758),
    new GeoPoint(37.726603, -122.402483),
    new GeoPoint(37.714805, -122.397974),
    new GeoPoint(37.704301, -122.394287),
    new GeoPoint(37.669787, -122.392891),
    new GeoPoint(37.660623, -122.403926),
    new GeoPoint(37.644247, -122.406364),
    new GeoPoint(37.63089, -122.402811),
    new GeoPoint(37.611007, -122.393655),
    new GeoPoint(37.601292, -122.378646),
    new GeoPoint(37.587965, -122.357438),
    new GeoPoint(37.573261, -122.316743),
    new GeoPoint(37.550567, -122.293655),
    new GeoPoint(37.548743, -122.291949),
    new GeoPoint(37.529546, -122.273979),
    new GeoPoint(37.506343, -122.247718),
    new GeoPoint(37.495907, -122.231907),
    new GeoPoint(37.487457, -122.205884),
    new GeoPoint(37.481693, -122.177417),
    new GeoPoint(37.466211, -122.150899),
    new GeoPoint(37.452112, -122.12693),
    new GeoPoint(37.428088, -122.101374),
    new GeoPoint(37.418478, -122.089184),
    new GeoPoint(37.411892, -122.078361),
    new GeoPoint(37.407713, -122.067189),
    new GeoPoint(37.403049, -122.047017),
    new GeoPoint(37.399611, -122.031169),
    new GeoPoint(37.396422, -122.016668),
    new GeoPoint(37.394702, -122.008838),
    new GeoPoint(37.389654, -121.991164),
    new GeoPoint(37.384341, -121.972437),
    new GeoPoint(37.377288, -121.945145),
    new GeoPoint(37.376128, -121.939052),
    new GeoPoint(37.368647, -121.908964),
    new GeoPoint(37.360758, -121.904873),
    new GeoPoint(37.351621, -121.914449),
    new GeoPoint(37.347299, -121.916365),
    new GeoPoint(37.346281, -121.91517),
    new GeoPoint(37.348591, -121.913474)
);

client.chargingOnRouteRequest()
    .setRoute(route)
    .setLocation(37.78509,-122.41988)
    .setEvContext(EvContext.builder()
            .setLowEnergyThreshold(30)
            .setRemainingRangeInKm(30)
            .setStateOfCharge(40)
            .build())
    .setEvFilter(EvFilter.builder()
            .setChargerBrands(Collections.singletonList("99100001"))
            .setPowerFeedLevels(Collections.singletonList(2))
            .setConnectorTypes(Collections.singletonList("30001"))
            .build())
    .asyncCall(new Callback<EvChargingOnRouteResponse>() {

        @Override
        public void onSuccess(EvChargingOnRouteResponse response) {

            for (EvCluster evCluster : response.getResults()) {
                List<Entity> evEntities = evCluster.getEntities();
                // ...
            }
        }

        @Override
        public void onFailure(Throwable t) {

        }
    });

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
val route = Arrays.asList(
    GeoPoint(37.78509, -122.41988),
    GeoPoint(37.785182, -122.417924),
    GeoPoint(37.785808, -122.412992),
    GeoPoint(37.786318, -122.408954),
    GeoPoint(37.785774, -122.406246),
    GeoPoint(37.783251, -122.402708),
    GeoPoint(37.781211, -122.400159),
    GeoPoint(37.779522, -122.398145),
    GeoPoint(37.774814, -122.400996),
    GeoPoint(37.760635, -122.39257),
    GeoPoint(37.749102, -122.392758),
    GeoPoint(37.726603, -122.402483),
    GeoPoint(37.714805, -122.397974),
    GeoPoint(37.704301, -122.394287),
    GeoPoint(37.669787, -122.392891),
    GeoPoint(37.660623, -122.403926),
    GeoPoint(37.644247, -122.406364),
    GeoPoint(37.63089, -122.402811),
    GeoPoint(37.611007, -122.393655),
    GeoPoint(37.601292, -122.378646),
    GeoPoint(37.587965, -122.357438),
    GeoPoint(37.573261, -122.316743),
    GeoPoint(37.550567, -122.293655),
    GeoPoint(37.548743, -122.291949),
    GeoPoint(37.529546, -122.273979),
    GeoPoint(37.506343, -122.247718),
    GeoPoint(37.495907, -122.231907),
    GeoPoint(37.487457, -122.205884),
    GeoPoint(37.481693, -122.177417),
    GeoPoint(37.466211, -122.150899),
    GeoPoint(37.452112, -122.12693),
    GeoPoint(37.428088, -122.101374),
    GeoPoint(37.418478, -122.089184),
    GeoPoint(37.411892, -122.078361),
    GeoPoint(37.407713, -122.067189),
    GeoPoint(37.403049, -122.047017),
    GeoPoint(37.399611, -122.031169),
    GeoPoint(37.396422, -122.016668),
    GeoPoint(37.394702, -122.008838),
    GeoPoint(37.389654, -121.991164),
    GeoPoint(37.384341, -121.972437),
    GeoPoint(37.377288, -121.945145),
    GeoPoint(37.376128, -121.939052),
    GeoPoint(37.368647, -121.908964),
    GeoPoint(37.360758, -121.904873),
    GeoPoint(37.351621, -121.914449),
    GeoPoint(37.347299, -121.916365),
    GeoPoint(37.346281, -121.91517),
    GeoPoint(37.348591, -121.913474)
)

client.chargingOnRouteRequest()
    .setRoute(route)
    .setLocation(37.78509, -122.41988)
    .setEvContext(EvContext.builder()
        .setLowEnergyThreshold(30.0)
        .setRemainingRangeInKm(30.0)
        .setStateOfCharge(40.0)
        .build())
    .setEvFilter(EvFilter.builder()
        .setChargerBrands(listOf("99100001"))
        .setPowerFeedLevels(listOf(2))
        .setConnectorTypes(listOf("30001"))
        .build())
    .asyncCall(object : Callback<EvChargingOnRouteResponse> {

        override fun onSuccess(response: EvChargingOnRouteResponse) {

            for (evCluster in response.results) {
                val evEntities = evCluster.entities
                // ...
            }

        }

        override fun onFailure(t: Throwable) {

        }
    })