getYOURip.de

API-Nutzung

1. Was macht diese API?

Diese API ermittelt die öffentliche IP-Adresse und den Hostnamen des Geräts, das die Anfrage stellt. Sie gibt die Informationen entweder im JSON- oder XML-Format zurück.

2. Basis-URL der API

Die API kann mit einer einfachen HTTP-GET-Anfrage unter der folgenden Basis-URL aufgerufen werden:

https://api.getyourip.de

3. Unterstützte HTTP-Methode

Die API verwendet die HTTP-Methode GET. Eine typische Anfrage könnte wie folgt aussehen:

GET https://api.getyourip.de

4. Ausgabeformate

Die API unterstützt zwei Ausgabeformate:

JSON (Standard): Das JSON-Format wird automatisch verwendet, wenn keine weiteren Parameter angegeben werden.
XML: Um die Ausgabe im XML-Format zu erhalten, füge den Parameter ?format=xml zur Anfrage hinzu.

Beispiele:

JSON-Ausgabe:
GET https://api.getyourip.de
Antwort:
{
    "ip": "123.45.67.89",
    "hostname": "example-host.com"
}

XML-Ausgabe:
GET https://api.getyourip.de?format=xml
Antwort:
<response>
    <ip>123.45.67.89</ip>
    <hostname>example-host.com</hostname>
</response>

5. Parameter der API

Die API unterstützt die folgenden Parameter:

format: Definiert das Ausgabeformat. Mögliche Werte sind json (Standard) und xml.
onlyip: Wenn dieser Parameter gesetzt ist, gibt die API nur die IP-Adresse des Nutzers zurück, ohne den Hostnamen oder andere Informationen. Die Ausgabe erfolgt entweder als reiner Text oder als XML, je nach gesetztem format-Parameter.

Beispiel: Um nur die IP-Adresse als Text zu erhalten, verwende:

GET https://api.getyourip.de?onlyip

Um die IP-Adresse im XML-Format zu erhalten, verwende:

GET https://api.getyourip.de?onlyip&format=xml

6. Nutzung eines API-Keys

Um das Rate-Limit zu umgehen, kannst du einen API-Key verwenden. Füge dazu den Parameter api_key zur Anfrage hinzu:

GET https://api.getyourip.de?api_key=YOUR_API_KEY

Beispiel mit einem API-Key:

GET https://api.getyourip.de?api_key=abcd1234efgh5678ijkl90mnopqrstuv

7. Fehlerbehandlung

Die API gibt standardisierte Fehlermeldungen im JSON-Format zurück. Mögliche Fehlercodes:

400 Bad Request: Die Anfrage war ungültig (z.B. fehlende oder falsche Parameter).
429 Too Many Requests: Das Rate-Limit wurde überschritten (max. 100 Anfragen pro Stunde ohne API-Key).
Invalid API key provided. Der genutzte API key ist nicht gültig.

8. Beispielcodes für verschiedene Programmiersprachen

cURL

curl https://api.getyourip.de?api_key=YOUR_API_KEY

Python (mit requests)

import requests

response = requests.get('https://api.getyourip.de', params={'api_key': 'YOUR_API_KEY'})
print(response.json())

JavaScript (fetch)

fetch('https://api.getyourip.de?api_key=YOUR_API_KEY')
    .then(response => response.json())
    .then(data => console.log(data));

9. Rate-Limit

Die API ist auf maximal 100 Anfragen pro Stunde begrenzt. Wenn dieses Limit überschritten wird, gibt die API den HTTP-Statuscode 429 (Too Many Requests) zurück. Mit einem gültigen API-Key kannst du dieses Limit umgehen.

Deine öffentliche IP-Adresse