Technical details Maplist API
Technical details Maplist API
On this page you can find a summary of the possibilities of the Maplist API version.
Token
In order to call the API of Eco-Movement you have to be a client.
Each HTTP request must have an ‘Authorization’ header. The header looks as follows:
Authorization: Token IpbJOXxkxOAuKR92z0nExampleVG7I7d/WCg0koM=
With this token the following parameters can be used.
Preface
Calling this API happens in two steps. First of all, all locations are retrieved in clusters. This is called the Clusterset request. And secondly, additional data can be retrieved per location. This is called the Location request.
These two steps are described below one by one.
Clusterset Request
The clusterset request supports the following parameters:
box – This is a required field. The box has two coordinates (bottom left, top right). The box returns only the charge locations in the given box coordinates. Format: LOlat, LOlong, RBlat, RBlong.
LOlat = latitude bottom left side
LOlong = longitude bottom left side
RBlat = latitude top right side
RBlong = longitude top right side
zoom – This is a required field. Possible values: 1,2,3,4,5,6,7,8,9,10,11,12. Only one value can be used per request.
accessType – This is an optional field. Possible values: public, company, private. More values can be used at the same time per request. (works only if the Accessibility attribute is part of your API agreement with Eco-Movement)
available – This is an optional field. Possible values: available, charging. More values can be used at the same time per request.
power – This is an optional field. Possible values: fast (> 43 kWh), normal (< 43 kWh). More values can be used at the same time per request. Cannot be used in combination with powerMax or powerMin.
powerMax – This is an optional field. Maximum power in Wh (3,7 kWh = 3700). Cannot be used in combination with power.
powerMin – This is an optional field. Minimum power in Wh. Cannot be used in combination with power.
Clusterset request example
endpoint: https://api.eco-movement.com/api/maplist/clusterset?box=52.16834821319255,4.8575247635650385,52.30606099468372,5.486835371475195&zoom=12&accessType=public&available=available,charging&power=fast,normal
Cluserset response example
{"status_code":1000,"status_message":"OK","data":[ {"point":{"lat":52.168532,"lng":5.38485},"id":"8bbaf2e2-4f3c-11e8-8d6a-42010a840002","status":{"available":"2","charging":"0"},"power":22000,"publicaccess":"Public"}, {"point":{"lat":52.168549,"lng":5.404424},"id":"eb3a9696-4f3c-11e8-b729-42010a840002","status":{"available":"1","charging":"1"},"power":11000,"publicaccess":"Company"}, ],"meta":{"chunk":{"offset":0,"limit":999999,"count":2,"min":0,"max":0,"next":null}}}
Result explanation
point – Returns the “lat” (latitude) and the “lng” (longitude) of the charging location.
id – Returns the location “id”. This “id” can be used at the locations request to get more details of the loaction.
status – Returns the number of spots that are “available” or “charging”.
power – Returns the maximal charging “power” of the spots watthours (Wh).
publicaccess – Returns the the accessibility of the charging location. (works only if the Accessibility attribute is part of your API agreement with Eco-Movement)
Public = 24 hours accessible.
Company = The location is located on company terrain. Opening times may occur. Perhaps it is necessary to have an appointment.
Private = The location is located on private terrain. Access must be requested from the owner.
Location request
The location request supports the following parameters:
location – This is a required field. The locations “id” can be used as input value. Only one value can be used per request.
Location request example
endpoint: https://api.eco-movement.com/api/maplist/location/5e83cb6e-4f3c-11e8-817a-42010a840002
Location response example
{ "status_code": 1000, "status_message": "OK", "data": { "id": "5e83cb6e-4f3c-11e8-817a-42010a840002", "name": "Allego NLALLEGO001113", "publicaccess": "Public", "chargingstation": { "type": "ON_STREET", "charging_when_closed": true, "time_zone": "Europe\/Amsterdam", "opening_times": { "twentyfourseven": true }, "operator": { "name": "Allego NL", "website": "https:\/\/www.allego.nl" }, "support": { "tel": "+(31)-(800)-3745337", "email": " info@allego.eu", "twitter_webcare": "https:\/\/twitter.com\/AllegoCharging", "facebook_page": "https:\/\/www.facebook.com\/allegocharging" }, "chargingspots": [{ "uid": "NLALLEGO0011132", "ocpi_evse_id": "NLALLEGO0011132", "physical_reference": "NLALLEGO0011132", "status": "Charging", "capabilities": ["REMOTE_START_STOP_CAPABLE", "RFID_READER"], "parking_restrictions": "EV_ONLY", "connectors": [ { "id": "1214353", "standard": "IEC_62196_T2", "format": "SOCKET", "power_type": "AC_3_PHASE", "voltage": 230, "amperage": 16, "max_power": 11040 }] }] }, "geographic": { "coordinates": { "latitude": "52.228900", "longitude": "5.001200" }, "geodata_type": "street_address", "street": "Stichtstraat 2", "postal_code": "3634 AR", "city": "Loenersloot", "countrycode": "NL" } } }