Entwickler API

Sämtliche Umrechnungskurse seit 2001 sind als Einzelwerte oder ganze Tabellen in verschiedenen Formaten über die API einzeln erreichbar. Die Werte in den Tabellen beziehen sich auf 1,- €.Invertierte Werte* sind ebenfalls abrufbar. Bei Abruf von Einzelwerten wird nach Angabe von Währung, Jahr, Monat und Betrag (in der Fremdwährung) der entsprechende Eurowert zurückgegeben.

Anwendungssyntax

In den folgenden Tabellen sind die entsprechenden GET-Parameter aufgelistet.

Rückgabe eines Einzelwertes

GET Variable Beschreibung mögliche Werte Vorgabewert
k API Schlüssel individueller Schlüssel
hier anfordern!
Testschlüssel: 12345 (nur für 2007)
Pflichtangabe
c Währung Währungs-Code nach ISO 4217
(3 Buchstaben Code)
Groß- oder Kleinschreibung
Pflichtangabe
y Jahr (int) 2001 bis heute (Jahr) aktuelles Jahr
m Monat (int) 1 bis 12 Vormonat
v umzurechnender Betrag (float) Kommazahl (Komma oder Punkt) 1
i Inversionsparameter (int) 1 oder 0 0
Rückgabewert
Zahl mit max. 2 Dezimalstellen

Beispiel Einzelwert

Der Aufruf von:
http://umsatzsteuer-umrechnungskurse.org/api/?k=12345&c=idr&y=2007&m=3&v=34560.67
gibt den Wert '2.85' zurück. Das bedeutet 34560,67 Indische Rupien entsprechen 2 € und 85 Cent.

Rückgabe einer oder mehrerer Tabellen

GET Variable Beschreibung mögliche Werte Vorgabewert
k API Schlüssel individueller Schlüssel
hier anfordern!
Testschlüssel: 12345 (nur für 2007)
Pflichtangabe
f Dateiformat xml, json, html, xls, csv, pdf Pflichtangabe
y Jahr (int) 2001 bis heute (Jahr) aktuelles Jahr
r Bereich (int) Anzahl der Jahre ab Parameter (y) nicht gesetzt (null)
i Inversionsparameter (int)
Nicht verfügbar für pdf Formate
1 oder 0 0

Hinweise

mehrere Jahre

Ist der Parameter Bereich (r) gesetzt und hat den Wert (int)0, werden alle Jahre bis zum aktuellen Jahr angezeigt.

Dateiformate

Für die Dateiformate pdf, xls und csv öffnet sich der Download Dialog. Die anderen Formate werden direkt zurückgegeben.

Die Dateiformate pdf und csv sind jeweils nur für ein einzelnes Jahr abrufbar. Der Parameter Bereich (r) wird ignoriert.

Invertierte Werte

Das API Parameter (i) erlaubt es nun alle Werte* und Tabellen* auch invertiert auszugeben. Ausgabe in Euro auf jeweils 1,- der jeweiligen Währung bezogen.
(*) ausgenommen Tabellen in pdf Format.

Beispiel Datentabelle

Der Aufruf von:
http://umsatzsteuer-umrechnungskurse.org/api/?k=12345&f=xml&y=2007
gibt das folgende XML Dokument zurück. (Ausschnitt)

Beim Datentyp 'html' wird eine Zeichenkette <table>...</table> zurückgegeben.

Anwendungsbeispiele

Einbinden der html.Tabelle


<!DOCTYPE html>
<html>
  <head>
    <title>Anwendungsbeispiel Beispiel #1</title>
    <meta charset="UTF-8" />
  </head>
  <body>
    <h1>Anwendungsbeispiel Beispiel #1</h1>
<?php print readfile('http://umsatzsteuer-umrechnungskurse.org/api/?k=12345&f=html&y=2007');?>
  </body>
</html>

Wie bekomme ich einen API Schlüssel?

Ganz einfach! Sie erhalten den API Schlüssel, indem Sie eine freiwillige Spende ab 5,- Euro, mit Ihrer E-mail Adresse im Betreff, auf das folgende Konto überweisen:
Christoph Thelen, IBAN: DE 0650 0105 1705 2138 9055, BIC: INGDDEFF
Schicken nach erfolgter Überweisung eine E-mail an mit dem Hinweis, dass Sie die, im Impressum veröffentlichten, Nutzungsbedingungen und die Datenschutzerklärung gelesen und akzeptiert haben. Sobald der Betrag auf dem Konto gutgeschrieben ist, erhalten Sie per E-Mail ihren persönlichen API Schlüssel, den Sie zeitlich unbegrenzt nutzen können. Zeitlich unbegrenzt bedeutet, solange dieser Service existiert und der Betreiber Eigentümer der Internetseite ist.

Kann ich den Service testen?

Ja! Nutzen Sie zu Testzwecken den Gastschlüssel: '12345'. Mit dem Gastschlüssel sind ausschliesslich Werte aus dem Jahr 2007 verfügbar. Der Bereichsparameter (r) wird hierbei ignoriert.

Werden die Daten aktualisiert?

Ja! Zu Beginn eines jeden Monats veröffentlicht das Bundesministerium der Finanzen die Daten für den Vormonats. Diese Daten sind in der Regel innerhalb einer Woche hier verfügbar.

Verfügbarkeit

Bitte beachten Sie, dass die Anfragen auf 1000 pro API Schlüssel und Monat limitiert sind. Grundsätzlich besteht kein Anspruch auf Verfügbarkeit dieses Dienstes.

Für die Einbindung des Rechnerwidgets per iframe gibt es keine Limitierung.

Sind noch weitere Ausgabeformate in Planung?

Ja! In Kürze werden die Daten auch im Simpletext (.txt) Format verfügbar sein. Die Ausgabe einer .sql Datei, um eine MYSQL Datentabelle zu generieren ist in Planung.

Widget

Inhaber eines API Schlüssels haben ab sofort die Möglichkeit das Rechnerwidget auf der Startseite per iframe in der eigenen Homepage einzubinden. Teilen Sie mir dazu per E-Mail an den Link zu der Seite mit, in der das Widget eingebunden werden soll (frame parent). Pro API Schlüssel kann jeweils nur eine Domain/ Subdomain eingetragen werden.

Einbindung des Widgets per iframe

Nur registrierte Domainnamen werden als frame parents (fp) akzeptiert. Fügen Sie ihren Domainnamen inklusive Protokoll (http oder https) als GET Parameter zur Frame Adresse im src-Attribut hinzu.

<iframe src="http://umsatzsteuer-umrechnungskurse.org/iframe-widget.php?fp=http://example.org" name="widget" frameborder="0"></iframe>

Damit das Widget immer vollständig sichtbar ist sollten Sie zur automatisierten Höhenanpassung das folgende Script vor dem schließenden body tag in ihre homepage einbinden:

   <script src="http://umsatzsteuer-umrechnungskurse.org/wire/modules/Jquery/JqueryCore/iframe-resizer.min.js"></script>
   <script>iFrameResize()</script>
</body>

Quelle: https://github.com/davidjbradshaw/iframe-resizer