Skip to main content
All endpoints require authentication.

​
GET /v1/bandwidth/current

Get the current month’s bandwidth usage for the authenticated user. Response (200): 
{
  "success": true,
  "data": {
    "used_bytes": 5368709120,
    "limit_bytes": 107374182400,
    "used_formatted": "5.00 GB",
    "limit_formatted": "100.00 GB",
    "percentage": 5.0,
    "unlimited": false,
    "reset_date": "2026-02-01"
  }
}
If on an unlimited plan: 
{
  "success": true,
  "data": {
    "used_bytes": 5368709120,
    "limit_bytes": null,
    "used_formatted": "5.00 GB",
    "limit_formatted": "Unlimited",
    "percentage": null,
    "unlimited": true,
    "reset_date": "2026-02-01"
  }
}

​
GET /v1/bandwidth/history

Get historical bandwidth usage by month. Response (200): 
{
  "success": true,
  "data": [
    {
      "period": "2026-01",
      "used_bytes": 10737418240,
      "used_formatted": "10.00 GB"
    },
    {
      "period": "2025-12",
      "used_bytes": 8589934592,
      "used_formatted": "8.00 GB"
    }
  ]
}

​
GET /v1/bandwidth/summary

Get a summary of total bandwidth usage across all services. Response (200): 
{
  "success": true,
  "data": {
    "total_used_bytes": 107374182400,
    "total_used_formatted": "100.00 GB",
    "current_month_bytes": 5368709120,
    "current_month_formatted": "5.00 GB"
  }
}