使用量とクォータAPI

これらのエンドポイントは、パネルのダッシュボードに表示されるものと同じ帯域幅の数値を返します。つまり、現在の請求サイクルでプランをどれだけ使用したか、そしてどれだけ残っているかです。Residential Proxiesでは、クォータを使い切った後にどうなるかも確認できます。

現在のサイクルではなく、任意の期間の消費量を取得するための使用履歴エンドポイントもあります。

認証

3つのエンドポイントはすべてapi_tokenクエリパラメータで認証します。トークンはパネルのAccount → API Tokensで生成してください。

?api_token=YOUR_API_TOKEN

アカウントおよびプランのエンドポイントは1分あたり60リクエスト、履歴エンドポイントは1分あたり30リクエストにレート制限されています。

アカウントの使用量

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

アクティブなプランごとに1つのエントリと、すべての従量制プランの合計を返します。

トークンは1つのワークスペースではなくお客様自身に紐づくため、お客様自身のプランおよび招待されたすべてのワークスペースのプランが対象になります。レスポンスでは最初にそれらのワークスペースが一覧表示され、各プランには所属するワークスペースがタグ付けされます。単一のワークスペースに絞り込むにはworkspaceを渡してください。

パラメータ	場所	必須	説明
`api_token`	query	yes	アカウントのAPIトークン
`workspace`	query	no	ワークスペースID。そのワークスペースのプランのみを返します

例:

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

レスポンス:

{
  "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配列には、個人用ワークスペースと、メンバーになっているすべてのワークスペースが一覧表示され、各プランには同じオブジェクトがworkspaceとして含まれます。

フィールド	説明
`id`	ワークスペースID。`workspace`クエリパラメータに渡す値です
`name`	ワークスペース名。お客様自身のものは`Personal`です
`role`	そのワークスペースでのロール。`owner`、`admin`、`billing`、`viewer`のいずれかです
`personal`	お客様自身のワークスペースの場合は`true`
`wallet_balance`	そのワークスペースのウォレット残高(USD)

パネルですべてのロールがプランを閲覧できるのと同様に、すべてのロールが使用量を取得できます。

workspacesは、絞り込みを行った場合でも常に完全な一覧です。そのため、IDを調べるには1回の呼び出しで十分です。

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

プランの使用量

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

単一のプランの使用量を返します。上記のmemberships配列に含まれるものと同じオブジェクトですが、workspaceブロックは含まれません。

{membership}パスパラメータは、プラン識別子のどちらの形式でも指定できます。パネルのプランページに表示されるMembership ID(例:68057)、またはプランのURLおよびこれらのレスポンスのidフィールドに含まれる短いコード(例:Rxqk)です。どちらも同じプランを指します。

これは、アクセスできるすべてのプランで機能します。お客様自身のプランと、所属するワークスペース内のすべてのプランです。

パラメータ	場所	必須	説明
`membership`	path	yes	Membership IDまたは短いコード
`api_token`	query	yes	アカウントのAPIトークン

例:

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

レスポンス:

{
  "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
  }
}

期間を指定した使用量

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

上記の2つのエンドポイントは「今回の請求サイクルの状況はどうか」に答えるものです。このエンドポイントは「この2つの時点の間にどれだけ使用したか」に答えるもので、これは別の問いです。サイクルの数値は更新時にリセットされるため、先週の火曜日や先月の使用量を知ることはできません。

パラメータ	場所	必須	説明
`membership`	path	yes	Membership IDまたは短いコード
`api_token`	query	yes	アカウントのAPIトークン
`start`	query	yes	期間の開始(この時点を含む)
`end`	query	yes	期間の終了(この時点を含まない)

startとendには、日付(2026-08-16)または完全なタイムスタンプ(2026-08-16T09:00:00)のどちらでも指定できます。日付のみの場合は午前0時を意味するため、1日分はstart=2026-08-16&end=2026-08-17となります。期間は最短で1時間、最長で366日です。

例:

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

レスポンス:

{
  "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
  }
}

使用量を日ごとにグラフ化するには、1日につき1回呼び出し、各日をそれぞれの期間として指定してください。合計は正確に一致するため、1週間分の日次呼び出しの合計は、その週全体を対象とした1回の呼び出しと同じ数値になります。

このエンドポイントは、他の2つの60リクエストではなく、1分あたり30リクエストにレート制限されています。

エラー

ステータス	意味
`400`	`start`または`end`が欠落している、解析できない、順序が逆である、または366日を超えて離れている
`503`	使用履歴が一時的に利用できない。バックオフして再試行してください

フィールド

フィールド	説明
`id`	プランの短いコード。数値のMembership IDと同様にパスで指定できます
`plan`	パネルに表示される製品名
`service`	製品ファミリー。例:`backconnect`、`static-residential-proxies`、`scraping`
`status`	プランのステータス。例:`Active`、`Active Trial`、`Overdue`
`metered`	プランに帯域幅のクォータがあるかどうか
`quota_bytes` / `quota_gb`	現在の請求サイクルで利用可能な帯域幅。プランに含まれる容量と、そのプランに対して購入したトラフィックの追加分の合計です
`used_bytes` / `used_gb`	現在の請求サイクルでこれまでに消費した帯域幅
`remaining_bytes` / `remaining_gb`	クォータから使用量を引いた値。ゼロ未満にはなりません
`overage_bytes` / `overage_gb`	含まれるクォータを超えた使用量。クォータ内に収まっている間はゼロです
`used_percent`	クォータに対する使用量の割合。超過している場合は100を上回ります
`resets_at`	サイクルが切り替わり、使用量がゼロに戻る時点のISO 8601タイムスタンプ
`overage_billed`	このプランで、クォータを超えた分がウォレットから請求されるかどうか
`overage_rate_per_gb`	クォータを超えた1 GBあたりの料金(USD)。超過分を請求しないプランでは`null`です
`wallet_balance`	ワークスペースのウォレット残高(USD)
`wallet_covers_gb`	そのレートで、残高によりクォータを超えておよそ何GB分を支払えるか

従量制ではないプラン

ISP ProxiesとSneaker Proxiesは無制限であり、Web Scraping APIとSERP APIのプランは帯域幅ではなくリクエスト数に基づいて課金されます。これらのプランは、「残りなし」と読み取れてしまうゼロではなく、"metered": falseとnullの数値を返します。それでも一覧には含まれるため、アカウントのレスポンスはお客様が保有するものの全体像を示します。

クォータを超えた利用

Residential Proxiesは上限で停止しません。上限を超えた使用量は、GBあたりのレートでワークスペースのウォレットから請求されるため、残高がある限りプランは動作し続けます。overage_rate_per_gbがそのレートであり、wallet_covers_gbは現在の残高がそのレートでおよそどこまで持つかを示します。これはremaining_gbに加えて利用できる量の大まかな見積もりです。

このレートはお客様の実効レートです。つまり、適用中のクーポンや割引を反映した後のプラン料金を、プランのクォータで割った値です。これは、パネルのプランページのOverage rateに表示される数値と同じであり、請求ジョブが課金に使用するものとも同じです。

知っておくべき点がいくつかあります。

ウォレットはプラン単位ではなく、ワークスペース単位です。複数のResidentialプランを利用している場合、各プランのwallet_covers_gbは残高全体がそのプランに充てられることを前提としています。つまり、すべて同じ残高を基に算出されています。
トライアル中は、overage_billedはfalseです。トライアルは請求を行う代わりに上限で一時停止するため、カバー量の数値はありません。レートは、トライアルが有料に移行した後のプランの料金であるため、引き続き表示されます。
その他のすべての製品では、overage_rate_per_gbはnullです。これらのプランは追加分を請求するのではなく、上限で停止します。
残高がゼロになり、クォータを使い切ると、資金を追加するかサイクルが更新されるまでサービスは一時停止します。

使用量のリセット

使用量は、直近30日間のローリングウィンドウではなく、現在の請求サイクル内での累積値です。プランが更新されるresets_atの時点でゼロに戻ります。

エラー

ステータス	意味
`401`	`api_token`が欠落しているか無効である
`403`	プランが、お客様の所属していないワークスペースにある
`404`	プランが見つからない
`429`	1分間に60リクエストを超えている。バックオフして再試行してください

始める

プロキシ

API

リソース

使用量とクォータAPI

認証

アカウントの使用量

ワークスペース

プランの使用量

期間を指定した使用量

エラー

フィールド

従量制ではないプラン

クォータを超えた利用

使用量のリセット

エラー