API Usage
Rufen Sie Echtzeit-Nutzungsstatistiken und den Kreditsaldo Ihres Piloterr-Kontos ab.
Endpunkt-Übersicht
Detaillierte Dokumentation, Preise und Anwendungsbeispiele.
ÜbersichtLink to Übersicht
Der Usage-Endpunkt gibt einen vollständigen Überblick über den Kreditverbrauch, den Abonnementstatus, die Ratenlimits und die API-Schlüsselmetadaten Ihres Piloterr-Kontos. Verwenden Sie ihn, um Ihre Nutzung programmatisch zu überwachen und Benachrichtigungen oder Aufladungen auszulösen, bevor Ihre Credits aufgebraucht sind.
SchnellstartLink to Schnellstart
GET https://api.piloterr.com/v2/usage
ParameterLink to Parameter
Dieser Endpunkt erfordert keine Abfrageparameter. Die Authentifizierung erfolgt über den x-api-key-Header.
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
x-api-key |
string | ja | Ihr privater Piloterr-API-Schlüssel |
AntwortfelderLink to Antwortfelder
| Feld | Typ | Beschreibung |
|---|---|---|
remaining |
number | Verbleibende Credits im Konto |
total_used |
number | Gesamte verbrauchte Credits seit Kontoerstellung |
renewal_date |
string | null | Datum der nächsten Abonnementverlängerung (ISO 8601) |
period.start |
string | Startdatum des aktuellen Abrechnungszeitraums |
period.end |
string | Enddatum des aktuellen Abrechnungszeitraums |
subscription.used |
number | Im aktuellen Zeitraum genutzte Abonnement-Credits |
subscription.total |
number | Gesamte pro Zeitraum zugeteilte Abonnement-Credits |
subscription.remaining |
number | Verbleibende Abonnement-Credits im aktuellen Zeitraum |
subscription.percent_used |
number | Prozentsatz der verbrauchten Abonnement-Credits |
credits.given |
number | Dem Konto gewährte Bonus-Credits |
credits.consumed |
number | Verbrauchte Bonus-Credits |
credits.remaining |
number | Verbleibende Bonus-Credits |
credits.percent_used |
number | Prozentsatz der verbrauchten Bonus-Credits |
rate_limit.per_minute |
number | null | Maximale API-Aufrufe pro Minute (null = unbegrenzt) |
rate_limit.per_second |
number | null | Maximale API-Aufrufe pro Sekunde (null = unbegrenzt) |
account.name |
string | Name des Piloterr-Kontos |
account.slug |
string | Slug-Kennung des Kontos |
api_key.alias |
string | Lesbare Bezeichnung des verwendeten API-Schlüssels |
api_key.active |
boolean | Gibt an, ob der API-Schlüssel derzeit aktiv ist |
api_key.category |
string | Kategorie des API-Schlüssels (z.B. development, production) |
api_key.expires |
string | null | Ablaufdatum des API-Schlüssels oder null wenn er nicht abläuft |
packs |
object | null | Einmalige API-Pakete, Paket für Paket (null, wenn das Konto keines hat). Bei Konten ohne Monatsplan ist subscription.total die Summe aller Pakete |
packs.count |
number | Anzahl aktiver Pakete |
packs.exhausted_count |
number | Anzahl vollständig verbrauchter Pakete |
packs.total |
number | Von allen aktiven Paketen gewährte Credits |
packs.used |
number | Über alle Pakete verbrauchte Credits |
packs.remaining |
number | Über alle Pakete verbleibende Credits |
packs.current |
object | null | Das aktuell verbrauchte Paket (Pakete werden in Kaufreihenfolge genutzt); null, wenn alle aufgebraucht sind |
packs.items[] |
object[] | Jedes aktive Paket: id, title, purchased_at, total, used, remaining, percent_used, exhausted |
GuthabenLink to Guthaben
Jeder Aufruf wird aus bis zu drei Guthaben bedient, immer in dieser Reihenfolge. Die Antwort weist jedes einzeln aus, damit Sie sehen, woher Ihre Credits stammen.
- Abonnementkontingent (
subscription): im Monatsplan enthaltene Aufrufe. Wird zu jeder Abrechnungsperiode zurückgesetzt (period,renewal_date). - Einmalige API-Pakete (
packs): einmal gekauft, nie zurückgesetzt, in Kaufreihenfolge verbraucht, sobald das Monatskontingent aufgebraucht ist.packs.currentist das aktuell genutzte Paket; jeder Eintrag zeigt eigeneusedundremaining. Bei Konten ohne Monatsplan meldetsubscriptiondie Summe aller Pakete. - Pay-as-you-go-Credits (
credits): nur genutzt, wenn Kontingent und Pakete aufgebraucht sind. Separat abgerechnet.
remaining ist der über alle drei Guthaben noch verfügbare Gesamtbetrag, total_used der insgesamt verbrauchte. Erreicht remaining 0, liefern Aufrufe 402, bis ein Paket oder Credits hinzukommen.
HinweiseLink to Hinweise
- Dieser Endpunkt erfordert einen gültigen
x-api-key-Header. Anfragen ohne Schlüssel geben401 Unauthorizedzurück. percent_used-Werte können 100 überschreiten bei Aufladungen oder Überschreitungsszenarien.rate_limit-Werte sindnullfür Pläne ohne Ratenbegrenzung.
HauptanwendungsfälleLink to Hauptanwendungsfälle
- Credits in Echtzeit überwachen und automatisierte Auflade-Abläufe auslösen, bevor das Kontingent erschöpft ist
- Interne Dashboards erstellen, die den API-Verbrauch pro Team oder Projekt anzeigen
- Alerting-Systeme einrichten, die das Team benachrichtigen, wenn die Nutzung einen definierten Schwellenwert überschreitet
- API-Schlüsselstatus und Ablauf prüfen, bevor Batch-Extraktionsjobs gestartet werden
Bereit loszulegen?
Ihre Web-Scraping-API ist nur einen Klick entfernt. Starten Sie mit +500 Credits, ohne Infrastruktur einrichten zu müssen, ohne Proxys zu verwalten und ohne Kreditkarte.
- +500 Credits
- Keine Kreditkarte erforderlich
- Alle Endpunkte enthalten