API für Nutzung & Kontingent

Diese Endpunkte liefern dieselben Bandbreitenwerte, die das Panel in Ihrem Dashboard anzeigt: wie viel Ihres Plans Sie in diesem Abrechnungszyklus verbraucht haben und wie viel noch übrig ist. Bei Residential Proxies erfahren Sie außerdem, was passiert, sobald das Kontingent aufgebraucht ist.

Es gibt auch einen Endpunkt für den Nutzungsverlauf, der den Verbrauch in einem beliebigen Zeitfenster statt im aktuellen Zyklus liefert.

Authentifizierung

Alle drei Endpunkte authentifizieren sich mit einem api_token-Query-Parameter. Erstellen Sie ein Token im Panel unter Account → API Tokens.

?api_token=YOUR_API_TOKEN

Die Konto- und Plan-Endpunkte sind auf 60 Anfragen pro Minute begrenzt, der Verlaufs-Endpunkt auf 30.

Nutzung des Kontos

GET https://shifter.io/api/v1/user/usage

Gibt einen Eintrag pro aktivem Plan zurück, dazu die Summen über alle Pläne mit Verbrauchsmessung.

Das Token gehört zu Ihnen und nicht zu einem einzelnen Workspace. Es deckt daher Ihre eigenen Pläne und die Pläne aller Workspaces ab, in die Sie eingeladen wurden. Die Antwort listet diese Workspaces vorab auf und kennzeichnet jeden Plan mit dem Workspace, zu dem er gehört. Übergeben Sie workspace, um die Antwort auf einen einzelnen Workspace einzugrenzen.

Parameter	In	Erforderlich	Beschreibung
`api_token`	query	ja	Ihr Account-API-Token
`workspace`	query	nein	Workspace-ID, um nur die Pläne dieses Workspace zurückzugeben

Beispiel:

curl "https://shifter.io/api/v1/user/usage?api_token=YOUR_API_TOKEN"

Antwort:

{
  "error": null,
  "code": 200,
  "data": {
    "totals": {
      "quota_bytes": 25000000000,
      "used_bytes": 12300000000,
      "remaining_bytes": 12700000000,
      "overage_bytes": 0,
      "quota_gb": 25,
      "used_gb": 12.3,
      "remaining_gb": 12.7,
      "overage_gb": 0,
      "used_percent": 49.2
    },
    "workspaces": [
      { "id": "qbz6", "name": "Personal", "role": "owner",  "personal": true,  "wallet_balance": 25.00 },
      { "id": "7dLm", "name": "Acme Inc", "role": "viewer", "personal": false, "wallet_balance": 0 }
    ],
    "memberships": [
      {
        "id": "aB3xY9",
        "plan": "Residential Proxies 25 GB",
        "service": "backconnect",
        "status": "Active",
        "metered": true,
        "quota_bytes": 25000000000,
        "used_bytes": 12300000000,
        "remaining_bytes": 12700000000,
        "overage_bytes": 0,
        "quota_gb": 25,
        "used_gb": 12.3,
        "remaining_gb": 12.7,
        "overage_gb": 0,
        "used_percent": 49.2,
        "resets_at": "2026-08-14T09:31:00+00:00",
        "overage_billed": true,
        "overage_rate_per_gb": 0.4,
        "wallet_balance": 25.00,
        "wallet_covers_gb": 62.5,
        "workspace": {
          "id": "qbz6",
          "name": "Personal",
          "role": "owner",
          "personal": true
        }
      },
      {
        "id": "kM7pQ2",
        "plan": "ISP Proxies 10 IPs",
        "service": "static-residential-proxies",
        "status": "Active",
        "metered": false,
        "quota_bytes": null,
        "used_bytes": null,
        "remaining_bytes": null,
        "overage_bytes": null,
        "quota_gb": null,
        "used_gb": null,
        "remaining_gb": null,
        "overage_gb": null,
        "used_percent": null,
        "resets_at": null,
        "overage_billed": false,
        "overage_rate_per_gb": null,
        "wallet_balance": 0,
        "wallet_covers_gb": null,
        "workspace": {
          "id": "7dLm",
          "name": "Acme Inc",
          "role": "viewer",
          "personal": false
        }
      }
    ]
  }
}

Workspaces

Wenn Sie in den Workspace einer anderen Person eingeladen wurden, erscheinen deren Pläne hier neben Ihren eigenen. Das Array workspaces listet Ihren persönlichen Workspace sowie jeden Workspace auf, in dem Sie Mitglied sind, und jeder Plan enthält dasselbe Objekt unter workspace:

Feld	Beschreibung
`id`	Workspace-ID, der Wert für den Query-Parameter `workspace`
`name`	Name des Workspace, `Personal` für Ihren eigenen
`role`	Ihre Rolle dort: `owner`, `admin`, `billing` oder `viewer`
`personal`	`true` für Ihren eigenen Workspace
`wallet_balance`	Guthaben im Wallet dieses Workspace, in USD

Jede Rolle kann die Nutzung lesen, genauso wie jede Rolle die Pläne im Panel sehen kann.

workspaces ist immer die vollständige Liste, auch wenn Sie filtern. Ein einziger Aufruf genügt also, um die IDs zu ermitteln:

curl "https://shifter.io/api/v1/user/usage?workspace=7dLm&api_token=YOUR_API_TOKEN"

Nutzung eines Plans

GET https://shifter.io/api/v1/memberships/{membership}/usage

Gibt die Nutzung eines einzelnen Plans zurück, dasselbe Objekt, das im obigen Array memberships erscheint, ohne den Block workspace.

Der Pfadparameter {membership} akzeptiert beide Formen der Plan-Kennung: die Membership ID, die im Panel auf der Planseite angezeigt wird (zum Beispiel 68057), oder den kurzen Code aus der Plan-URL und dem Feld id in diesen Antworten (zum Beispiel Rxqk). Beide führen zum selben Plan.

Das funktioniert für jeden Plan, auf den Sie Zugriff haben: Ihre eigenen und alle in einem Workspace, dem Sie angehören.

Parameter	In	Erforderlich	Beschreibung
`membership`	path	ja	Membership ID oder kurzer Code
`api_token`	query	ja	Ihr Account-API-Token

Beispiel:

curl "https://shifter.io/api/v1/memberships/68057/usage?api_token=YOUR_API_TOKEN"

Antwort:

{
  "error": null,
  "code": 200,
  "data": {
    "id": "aB3xY9",
    "plan": "Residential Proxies 25 GB",
    "service": "backconnect",
    "status": "Active",
    "metered": true,
    "quota_bytes": 25000000000,
    "used_bytes": 12300000000,
    "remaining_bytes": 12700000000,
    "overage_bytes": 0,
    "quota_gb": 25,
    "used_gb": 12.3,
    "remaining_gb": 12.7,
    "overage_gb": 0,
    "used_percent": 49.2,
    "resets_at": "2026-08-14T09:31:00+00:00",
    "overage_billed": true,
    "overage_rate_per_gb": 0.4,
    "wallet_balance": 25.00,
    "wallet_covers_gb": 62.5
  }
}

Nutzung in einem Zeitraum

GET https://shifter.io/api/v1/memberships/{membership}/usage/history

Die beiden obigen Endpunkte beantworten die Frage “Wie läuft dieser Abrechnungszyklus?”. Dieser hier beantwortet “Wie viel habe ich zwischen diesen beiden Zeitpunkten verbraucht?”, und das ist eine andere Frage: Die Zykluswerte werden bei der Verlängerung zurückgesetzt und können daher nichts über letzten Dienstag oder den letzten Monat aussagen.

Parameter	In	Erforderlich	Beschreibung
`membership`	path	ja	Membership ID oder kurzer Code
`api_token`	query	ja	Ihr Account-API-Token
`start`	query	ja	Beginn des Zeitfensters, inklusiv
`end`	query	ja	Ende des Zeitfensters, exklusiv

start und end akzeptieren entweder ein Datum (2026-08-16) oder einen vollständigen Zeitstempel (2026-08-16T09:00:00). Ein reines Datum bedeutet Mitternacht, ein einzelner Tag ist also start=2026-08-16&end=2026-08-17. Das Zeitfenster kann mindestens eine Stunde und höchstens 366 Tage umfassen.

Beispiel:

curl "https://shifter.io/api/v1/memberships/68057/usage/history?start=2026-08-16&end=2026-08-17&api_token=YOUR_API_TOKEN"

Antwort:

{
  "error": null,
  "code": 200,
  "data": {
    "id": "aB3xY9",
    "start": "2026-08-16T00:00:00",
    "end": "2026-08-17T00:00:00",
    "bytes": 184699800000,
    "gb": 184.7,
    "upload_bytes": 8146690000,
    "download_bytes": 176553110000,
    "requests": 3775940
  }
}

Um die Nutzung Tag für Tag darzustellen, rufen Sie den Endpunkt einmal pro Tag auf und verwenden jeden Tag als eigenes Zeitfenster. Die Summen addieren sich exakt, eine Woche täglicher Aufrufe ergibt also denselben Wert wie ein einziger Aufruf über die ganze Woche.

Dieser Endpunkt ist auf 30 Anfragen pro Minute begrenzt, statt auf die 60 der beiden anderen.

Fehler

Status	Bedeutung
`400`	`start` oder `end` fehlt, ist nicht lesbar, steht in falscher Reihenfolge oder liegt mehr als 366 Tage auseinander
`503`	Der Nutzungsverlauf ist vorübergehend nicht verfügbar, mit Backoff erneut versuchen

Felder

Feld	Beschreibung
`id`	Der kurze Code des Plans, der im Pfad neben der numerischen Membership ID akzeptiert wird
`plan`	Produktname, wie er im Panel erscheint
`service`	Produktfamilie, z. B. `backconnect`, `static-residential-proxies`, `scraping`
`status`	Status des Plans, z. B. `Active`, `Active Trial`, `Overdue`
`metered`	Ob der Plan überhaupt ein Bandbreitenkontingent hat
`quota_bytes` / `quota_gb`	Im aktuellen Abrechnungszyklus verfügbare Bandbreite: das im Plan enthaltene Volumen plus alle Traffic-Aufladungen, die Sie dafür gekauft haben
`used_bytes` / `used_gb`	Im aktuellen Abrechnungszyklus bisher verbrauchte Bandbreite
`remaining_bytes` / `remaining_gb`	Kontingent minus Verbrauch, mindestens null
`overage_bytes` / `overage_gb`	Verbrauch über das enthaltene Kontingent hinaus, null, solange Sie noch innerhalb des Kontingents liegen
`used_percent`	Verbrauch in Prozent des Kontingents. Steigt über 100, wenn Sie das Kontingent überschritten haben
`resets_at`	ISO-8601-Zeitstempel, zu dem der Zyklus wechselt und der Verbrauch auf null zurückgeht
`overage_billed`	Ob bei diesem Plan eine Überschreitung des Kontingents aus dem Wallet abgerechnet wird
`overage_rate_per_gb`	Was jedes GB über dem Kontingent kostet, in USD. `null` bei Plänen, die keine Überschreitung abrechnen
`wallet_balance`	Guthaben im Wallet des Workspace, in USD
`wallet_covers_gb`	Ungefähr wie viele GB über dem Kontingent das Guthaben zu diesem Satz abdeckt

Pläne ohne Verbrauchsmessung

ISP Proxies und Sneaker Proxies sind unbegrenzt, und Pläne für Web Scraping API und SERP API werden pro Anfrage statt nach Bandbreite berechnet. Diese Pläne melden "metered": false mit null-Werten statt einer Null, die als “nichts mehr übrig” gelesen würde. Sie werden trotzdem aufgelistet, sodass die Kontoantwort ein vollständiges Bild Ihrer Pläne ergibt.

Über das Kontingent hinaus

Residential Proxies stoppt nicht am Limit: Der Verbrauch darüber hinaus wird zu einem Satz pro GB aus dem Wallet Ihres Workspace abgerechnet, sodass der Plan weiterläuft, solange Guthaben vorhanden ist. overage_rate_per_gb ist dieser Satz, und wallet_covers_gb gibt ungefähr an, wie weit das aktuelle Guthaben damit reicht, eine grobe Reichweitenschätzung zusätzlich zu remaining_gb.

Der Satz ist Ihr effektiver Satz: Planpreis geteilt durch Plankontingent, nach Abzug eines Gutscheins oder Rabatts, den Sie nutzen. Es ist derselbe Wert, den das Panel auf der Planseite unter Overage rate anzeigt, und derselbe, zu dem der Abrechnungsjob abrechnet.

Einige wissenswerte Punkte:

Das Wallet gilt pro Workspace, nicht pro Plan. Wenn Sie mehrere Residential-Pläne betreiben, geht wallet_covers_gb bei jedem davon aus, dass das gesamte Guthaben diesem Plan zufließt. Alle rechnen mit demselben Topf.
Während einer Testphase ist overage_billed gleich false. Testphasen pausieren bei ihrem Volumen, statt abzurechnen, daher gibt es keinen Abdeckungswert. Der Satz wird trotzdem angegeben, da er dem entspricht, was der Plan kostet, sobald die Testphase in einen bezahlten Plan übergeht.
Bei jedem anderen Produkt ist overage_rate_per_gb gleich null: Diese Pläne stoppen an ihrem Limit, statt mehr abzurechnen.
Wenn das Guthaben null erreicht und das Kontingent aufgebraucht ist, pausiert der Dienst, bis Sie Guthaben aufladen oder der Zyklus sich erneuert.

Zurücksetzen der Nutzung

Die Nutzung ist innerhalb des aktuellen Abrechnungszyklus kumulativ, kein rollierendes 30-Tage-Fenster. Sie geht bei resets_at auf null zurück, wenn der Plan verlängert wird.

Fehler

Status	Bedeutung
`401`	Fehlendes oder ungültiges `api_token`
`403`	Der Plan liegt in einem Workspace, dem Sie nicht angehören
`404`	Plan nicht gefunden
`429`	Mehr als 60 Anfragen in einer Minute, mit Backoff erneut versuchen

Jetzt starten

Proxies

APIs

Ressourcen

API für Nutzung & Kontingent

Authentifizierung

Nutzung des Kontos

Workspaces

Nutzung eines Plans

Nutzung in einem Zeitraum

Fehler

Felder

Pläne ohne Verbrauchsmessung

Über das Kontingent hinaus

Zurücksetzen der Nutzung

Fehler