API-Zugriff

Viele Daten dieser Website können direkt über eine HTTP-Schnittstelle abgefragt werden. Bisher wird die Suche nach Wörtern, Teilwörtern und nach ähnlich geschriebenen Wörtern unterstützt. Noch nicht unterstützt wird die Wikipedia/Wiktionary-Suche.

Hinweis: das Ausgabe-Format kann sich ändern. Es wird jedoch nur erweitert, bestehende Teile werden nicht ohne Ankündigung geändert.

Suchanfrage

Mit der folgenden HTTP-Anfrage via GET können alle Synonymgruppen, die das Wort query beinhalten, abgefragt werden:

http://www.openthesaurus.de/synonyme/search?q=query&format=text/xml

Ergebnis

Das Ergebnis der Anfrage ist eine XML-Datei mit folgendem Format:

<matches>
  <metaData>
    <apiVersion content="0.1.3"/>
    <warning content="WARNING -- this API is in beta -- the format may change without warning!"/>
    <copyright content="Copyright (C) 2009 Daniel Naber (www.danielnaber.de)"/>
    <license content="GNU LESSER GENERAL PUBLIC LICENSE Version 2.1"/>
    <source content="http://www.openthesaurus.de"/>
    <date content="Sat Mar 06 22:47:25 CET 2010"/>
  </metaData>
  <synset id="1234">
    <categories>
      <category name="Name der Kategorie"/>
    </categories>
    <term term="Bedeutung 1, Wort 1"/>
    <term term="Bedeutung 1, Wort 2"/>
  </synset>
  <synset id="2345">
    <categories/>
    <term term="Bedeutung 2, Wort 1"/>
  </synset>
</matches>

Optionen

format=text/xml: Hiermit wird die Antwort als XML zurückgeliefert. Andere einfach auswertbare Formate werden derzeit nicht unterstützt.
similar=true: Hiermit werden bei jeder Antwort auch bis zu fünf ähnliche Wörter zurückgegeben. Dies ist nützlich, um dem User einen Vorschlag im Falle eines möglichen Tippfehlers machen zu können. Beispielanfrage:
```
http://www.openthesaurus.de/synonyme/search?q=Umstant&format=text/xml&similar=true
```
Antwort (Ausschnitt):
```
<similarterms>
  <term term="Umstand" distance="1"/>
  <term term="(zeitlicher) Abstand" distance="3"/>
  <term term="Abstand" distance="3"/>
  <term term="amüsant" distance="3"/>
  <term term="Anstalt" distance="3"/>
</similarterms>
```
distance gibt den Levenshtein-Abstand zum Suchwort an (Wörter in Klammern werden dabei ignoriert). Die Wörter sind bereits nach diesem Abstand sortiert. Es werden nur Wörter vorgeschlagen, die auch in OpenThesaurus vorhanden sind. Dieses Feature eignet sich also nicht dazu, die Vorschläge einer Rechtschreibprüfung zu generieren.
substring=true: Hiermit werden bei jeder Antwort auch bis zu zehn Wörter zurückgegeben, die den Suchbegriff nur als Teilwort beinhalten. Beispielanfrage:
```
http://www.openthesaurus.de/synonyme/search?q=Hand&format=text/xml&substring=true
```
Antwort (Ausschnitt):
```
<substringterms>
  <term term="(etwas) behandeln"/>
  <term term="abhandeln"/>
</substringterms>
```
substringFromResults: Gibt an, ab welchem Eintrag die Teilwort-Treffer zurückgegeben werden sollen. Funktioniert nur zusammen mit substring=true. Standardwert ist 0, also ab der ersten Position.
substringMaxResults: Gibt an, wie viele Teilwort-Treffer insgesamt zurückgegeben werden sollen. Funktioniert nur zusammen mit substring=true. Der Standardwert ist 10, Maximalwert ist 250.
mode=all: Aktiviert alle zusätzlichen Abfragen. Bisher sind das similar=true und substring=true.

Bekannte Probleme

Umlaute werden bei der Suche wie ihre nicht-Umlaute behandelt, so findet tur auch den Eintrag zu Tür und umgekehrt.

Download

Zusätzlich zur direkten Abfrage stehen weiterhin Downloads der gesamten Datenbank zur Verfügung.