---
title: "Traffic balance, expiry, credentials and purchase limits"
method: GET
path: "/v1/traffic"
tags: ["traffic"]
---

# Traffic balance, expiry, credentials and purchase limits

`GET /v1/traffic`

## Request

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

One GB balance per organisation, usable on the mobile 4G/5G and the residential pool. `credentials` is null until the first purchase is fulfilled, and for an API key without the `ports:write` scope (the balance stays readable with `ports:read`). `usage` is synced from the gateway every 5 minutes. With `limits.validity_days` 0 GB never expire and `expires_at` is null; with a positive value every purchase extends `expires_at` to max(now, current expiry) + that many days.

## Response `200`

Default Response

- object
  - `id` string, nullable, required
  - `status` 'none' | 'active' | 'exhausted' | 'expired' | 'suspended', required
  - `gb_total` number, required
  - `gb_used` number, required
  - `gb_left` number, required
  - `expires_at` string, date-time, nullable, required
  - `enabled` boolean, required
  - `last_synced_at` string, date-time, nullable, required
  - `credentials` object, nullable, required
    - `host` string, required
    - `http_port` integer, required
    - `socks_port` integer, required
    - `username_base` string, required
    - `password` string, required
  - `usage_daily` object[], required
    - `date` string, required
    - `gb` number, required
  - `limits` object, required
    - `validity_days` integer, required
    - `kyb_tier` string, required
    - `t0_monthly_gb_cap` number, required
    - `gb_bought_30d` number, required
    - `gb_remaining_30d` number, nullable, required
    - `trial_available` boolean, required
    - `max_order_gb` integer, 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)