---
title: "Residential traffic usage"
method: GET
path: "/api/v1/residential/usage"
---

# Residential traffic usage

`GET /api/v1/residential/usage`

## Request

- Base URL: `https://ipmusk.com`
- URL: `https://ipmusk.com/api/v1/residential/usage`
- Auth: HTTP bearer

Daily usage for the last 7 or 30 days (default 30), the active packages, a 7-day daily average and when the traffic is projected to run out. Figures are as of the last sync (packages.syncedAt). Keys are camelCase.

## Query parameters

- `days` '7' | '30': Range in days. Default 30.

## Response `200`

Residential traffic usage

- object
  - `data` object, required
    - `rangeDays` union, required
      - 7
      - 30
    - `startDate` string, required
    - `endDate` string, required
    - `series` object[], required
      - `date` string, required
      - `bytes` integer, required
      - `updating` boolean, required
      - `recorded` boolean, required
    - `rangeTotalBytes` integer, required
    - `lastUpdatedAt` string, nullable, required
    - `packages` object, nullable, required
      - `packageCount` integer, required
      - `totalBytes` integer, nullable, required
      - `usedBytes` integer, nullable, required
      - `remainingBytes` integer, required
      - `remainingPercent` number, nullable, required
      - `earliestExpiry` string, nullable, required
      - `syncedAt` string, nullable, required
    - `dailyAverageBytes` integer, nullable, required
    - `averageDays` integer, required
    - `projection` union, required
      - object
        - `kind` 'runs_out', required
        - `date` string, required
      - object
        - `kind` 'left_at_expiry', required
        - `bytes` integer, required
        - `date` string, required
  - `request_id` string, required

## Other responses

- `default`: Any failure: 400 validation_error, 401 authentication_required, 403 forbidden / capability_unavailable, 404 not_found, 409 invalid_state_transition / idempotency_conflict, 422 product_unavailable, 429 rate_limited, 500 internal_error.

---

[API](https://skmtc.dev/ipmusk/apis/ipmusk-customer-api.md) · [All operations](https://skmtc.dev/ipmusk/apis/ipmusk-customer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ipmusk/apis/ipmusk-customer-api/revisions/89f8b46fda61?raw)