Dokumentation der Stromtankstellen API
Hier findest du die Dokumentation zur API des Stromtankstellenverzeichnisses. Falls noch nicht geschehen, kannst du dir hier einen Zugang erstellen.
Der Zugang zur API erfolgt mit Key über die Adresse
https://api.goingelectric.de/chargepoints/
Der API können neben dem API-Key diverse Parameter per GET übergeben werden, welche im Folgenden beschrieben werden.
Bei Fragen zur API, gerne an die info@goingelectric.de wenden.
API Schlüssel
key
Der persönliche Schlüssel wird für alle aufgeführten Anfragen benötigt.
Suche mit Position und Umkreis
lat
Breitengrad als Dezimalzahl
lng
Längengrad als Dezimalzahl
radius
Radius in Kilometer, ganzzahlig
Suche mit Kartenausschnitt
sw_lat
Breitengrad des südwestlichsten Punktes des Ausschnitts als Dezimalzahl
sw_lng
Längengrad des südwestlichsten Punktes des Ausschnitts als Dezimalzahl
ne_lat
Breitengrad des nordöstlichsten Punktes des Ausschnitts als Dezimalzahl
ne_lng
Längengrad des nordöstlichsten Punktes des Ausschnitts als Dezimalzahl
Mit folgenden Parametern kann das Ergebnis weiter eingeschränkt werden
plugs
es können mehrere Anschlussarten angegeben werden, kommasepariert - siehe Pluglist weiter unten
countries
es können mehrere Länder angegeben werden, kommasepariert - Format nach ISO 3166 ALPHA-2 (DE für Deutschland, AT für Österreich, CH für die Schweiz, usw.)
min_power
minimale Leistung der Anschlüsse in kW, ganzzahlig
freecharging
nur kostenlose Ladepunkte, boolescher Wert
freeparking
nur kostenloses Parken an der Ladesäule, boolescher Wert
open_twentyfourseven
nur Ladesäulen, die 24/7 nutzbar sind (oder für die noch keine Informationen zu Öffnungszeiten vorliegen), boolescher Wert
open_now
nur Ladesäulen, die jetzt nutzbar sind (oder für die noch keine Informationen zu Öffnungszeiten vorliegen), boolescher Wert
open_day
nur Ladesäulen, die an einem bestimmten Tag nutzbar sind (oder für die noch keine Informationen zu Öffnungszeiten vorliegen), ganzzahlig, 0 - 6 (0 entspricht Sonntag)
open_time
nur Ladesäulen, die zu einer bestimmten Zeit nutzbar sind (oder für die noch keine Informationen zu Öffnungszeiten vorliegen), ganzzahlig, 0 - 2400 (Stunden-Minuten, ohne Trennzeichen)
verified
nur durch Nutzer verifizierte Ladepunkte, boolescher Wert
exclude_faults
Ladepunkte mit Fehlermeldung ausblenden, boolescher Wert
orderby
distance (Abstand Luftlinie aufsteigend, nur bei Position und Umkreis) oder power (Leistung der Anschlüsse, absteigend)
Bei Angabe folgender Parameter, werden alle Ladesäulen ausgegeben, die mindestens eines der Kriterien erfüllen
barrierfreenur Ladepunkte, die ohne Vertrag mit den üblichen Mittel - Bargeld, EC. o. Kreditkarte, beliebige RFID-Karte - nutzbar sind, boolescher Wert
networks
es können mehrere Ladenetzwerke angegeben werden, kommasepariert - siehe Networklist weiter unten
chargecards
es können mehrere Zugangskarten-IDs angegeben werden, kommasepariert - siehe Chargecardlist weiter unten
Die API gibt maximal 500 Standorte auf einmal zurück. Sollten weitere Standorte den Kriterien entsprechen, wird ein Startkey zurückgegeben, mit dem eine weitere Anfrage gestellt werden kann.
startkey
ganzzahlig, wird von der API ausgegeben
Zusammenfassen von nahe beieinanderliegenden Standorten
Um Anfragen an die API zu sparen, können nahe beieinanderliegende Ladepunkte bereits von der API zusammengefasst werden.
clustering
boolescher Wert
zoom
ganzzahlig, zwischen 0 und 21 - entspricht der Google Maps API
cluster_distance
entspricht ungefähr dem Abstand in Pixeln in Google Maps, in dem Standorte zusammengefasst werden, abhängig von der Zoomstufe
Abrufen von Detailinformationen
ge_id
Für vollständige Details können bis zu 10 IDs übergeben werden
result_details=minimal (optional)
Wird mit diesem Parameter eine reduzierte Liste angefordert, können bis zu 100 IDs übergeben werden
Fotos
https://api.goingelectric.de/chargepoints/photo/
Parameter
idid laut Detailinformationen
size
ganzzahlig, Größe der längsten Seite in Pixel, max. 1000. Ursprüngliches Seitenverhältnis bleibt erhalten.
Achtung, die Fotos haben unterschiedliche Ausrichtungen und Bildformate.
alternativ Breite und Höhe
widthganzzahlig, Breite des Fotos in Pixel. Sollte das Seitenverhältnis nicht dem ursprünglichen entsprechen, werden Überstände abgeschnitten.
height
ganzzahlig, Höhe des Fotos in Pixel.
Liste der vorhandenen Anschlüsse
https://api.goingelectric.de/chargepoints/pluglist/
Außer dem Key müssen keine weiteren Parameter übergeben werden
Diese Liste unterliegt Änderungen, so wird beispielsweise mit dem nächsten Update zwischen Typ2-Dose und Typ2-Stecker unterschieden werden. Daher macht es Sinn, diese Liste beim Start der App zu aktualisieren.
Liste der Ladenetzwerke
https://api.goingelectric.de/chargepoints/networklist/
Die Liste der Ladenetzwerke kann mit dem Parameter countries auf Länder beschränkt werden.
optionale Parameter
countrieses können mehrere Länder angegeben werden, kommasepariert - Format nach ISO 3166 ALPHA-2
Liste der Zugangskarten
https://api.goingelectric.de/chargepoints/chargecardlist/
Die Liste der Zugangskarten - dies sind nicht zwangsläufig Karten und können auch Apps oder Webseiten zur Freischaltung sein - kann mit dem Parameter countries auf Länder beschränkt werden. Maßgeblich ist dabei der Sitz des Anbieter. Teilweise ist länderübergreifendes Roaming möglich.
Die ID der Zugangskarte kann zur Filterung passender Ladesäulen genutzt werden. Details siehe oben.
optionale Parameter
countrieses können mehrere Länder angegeben werden, kommasepariert - Format nach ISO 3166 ALPHA-2
Beispielhafte Ausgabe
{"status":"ok", "chargelocations": [{ "ge_id":3, "name":"Karlsplatz", "address":{ "street":"Obere Karlsstraße 14", "postcode":"34117", "country":"Deutschland", "city":"Kassel"}, "chargepoints": [{ "count":4, "power":22, "type":"Typ2"}, { "count":4, "power":2, "type":"Schuko"}], "coordinates":{ "lng":9.494378, "lat":51.312454}, "fault_report":false, "network":"Ladenetz", "url":"//www.goingelectric.de/stromtankstellen/Deutschland/Kassel/Karlsplatz-Obere-Karlsstrasse-14/3/", "verified":true }, { ... }] }
Beispielhafte Ausgabe bei Abruf eines Eintrags
{"status":"ok", "chargelocations": [{ "ge_id":688, "name":"Betriebsgelände der STAWAG", "address":{ "street":"Lombardenstraße 12", "postcode":"52070", "country":"Deutschland", "city":"Aachen"}, "chargecards": [{ "id":2}, { "id":3}, { "id":9}, ... ], "coordinates":{ "lng":6.10185, "lat":50.782799}, "chargepoints": [{ "count":2, "power":22, "type":"Typ2"}, { "count":1, "power":50, "type":"CHAdeMO"}, { "count":4, "power":2, "type":"Schuko"}], "network":"Ladenetz", "operator":"Stadtwerke Aachen", "cost":{ "description_short":"Je nach Anbieter und Tarif", "freeparking":true, "freecharging":false, "description_long":false}, "fault_report":{ "created":1475100000, "description":"Laut Pförtner ist die Säule aktuell defekt. Keine weiteren Informationen erhalten."}, "verified":true, "barrierfree":false, "openinghours":{ "days":{ "wednesday":"from 07:00 till 19:00", "thursday":"from 07:00 till 19:00", "monday":"from 07:00 till 19:00", "sunday":"closed", "saturday":"closed", "tuesday":"from 07:00 till 19:00", "friday":"from 07:00 till 19:00"}, "description":false, "24/7":false}, "url":"//www.goingelectric.de/stromtankstellen/Deutschland/Aachen/Betriebsgelaende-der-STAWAG-Lombardenstrasse-12/688/", "ladeweile":"Ca. 5 Minuten zu Fuß zur Carolustherme!", "location_description":"Auf dem Betriebsgelände der STAWAG.", "general_information":false }, { ... }] }