Zum Hauptinhalt springen
Piloterr
Zurück zur Bibliothek

API Usage

Rufen Sie Echtzeit-Nutzungsstatistiken und den Kreditsaldo Ihres Piloterr-Kontos ab.

AktivKostenlosGET/v2/usage

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

HinweiseLink to Hinweise

  • Dieser Endpunkt erfordert einen gültigen x-api-key-Header. Anfragen ohne Schlüssel geben 401 Unauthorized zurück.
  • percent_used-Werte können 100 überschreiten bei Aufladungen oder Überschreitungsszenarien.
  • rate_limit-Werte sind null fü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