---
title: "Pool credentials and usage per product"
method: GET
path: "/v1/bandwidth"
tags: ["bandwidth"]
---

# Pool credentials and usage per product

`GET /v1/bandwidth`

## Request

- Base URL: `https://api.portproof.org`
- URL: `https://api.portproof.org/v1/bandwidth`
- Auth: one of:
  - API key in cookie `pp_session`
  - HTTP bearer

## Response `200`

Default Response

- object
  - `data` object[], required
    - `id` string, required
    - `product` object, required
      - `id` string, required
      - `sku` string, required
      - `kind` 'port' | 'bandwidth' | 'topup' | 'sms' | 'esim', required
      - `title` string, required
      - `country` string, nullable, required
      - `carrier_hint` string, nullable, required
      - `term` 'monthly' | 'weekly' | 'daily' | 'gb' | 'none', required
      - `sell_cents` integer, required
      - `currency` 'EUR' | 'USD', required
      - `evidence` 'signed' | 'observed', required
      - `operator_label` string, required
      - `stock` integer, nullable, required
      - `available` boolean, required
      - `supply_health` 'ok' | 'degraded' | 'down' | 'unknown', required
      - `tiers` object[], nullable
        - `min_qty` integer, required
        - `unit_cents` integer, required
      - `gb_per_unit` number, nullable
      - `once_per_customer` boolean
    - `host` string, required
    - `port` integer, required
    - `username` string, required
    - `password` string, nullable, required
    - `gb_purchased` number, required
    - `gb_used` number, required
    - `gb_remaining` number, required
    - `status` 'active' | 'exhausted' | 'revoked', required
    - `proxy_url` string, nullable, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required

## Other responses

- `401`: Default Response

---

[API](https://skmtc.dev/portproof/apis/portproof-api.md) · [All operations](https://skmtc.dev/portproof/apis/portproof-api/llms.txt) · [OpenAPI document](https://skmtc.dev/portproof/apis/portproof-api/revisions/4143916c0fac?raw)