---
title: "Return cPanel account bandwidth information"
method: GET
path: "/showbw"
tags: ["Bandwidth and Disk Quotas"]
---

# Return cPanel account bandwidth information

`GET /showbw`

This function retrieves account bandwidth information.

## Query parameters

- `month` integer
- `search` string
- `searchtype` 'domain' | 'owner' | 'user' | 'ip' | 'package'
- `showres` string
- `year` integer

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `acct` object[] — Bandwidth information for the reseller's accounts.
      - `bwusage` object[] — The bandwidth information for domains on the account.
        - `deleted` 1 | 0 — Whether the account was deleted. * `1` — Deleted. * `0` — **Not** deleted.
        - `domain` string — The domain on the account.
        - `usage` integer — The domain's bandwidth usage during the queried period, in bytes.
      - `deleted` 1 | 0 — Whether the account was deleted. * `1` — Deleted. * `0` — **Not** deleted.
      - `limit` integer — The account's bandwidth limit, in bytes.
      - `maindomain` string — The account's main domain.
      - `owner` string — The account's owner.
      - `reseller` 1 | 0 — Whether the user is a reseller. * `1` — Reseller account. * `0` — **Not** a reseller account.
      - `totalbytes` integer — The account's total bandwidth usage during the queried period, in bytes.
      - `user` string — The account username.
    - `month` integer — The queried month.
    - `reseller` string — The reseller username or the `root` user.
    - `totalused` integer — The total bandwidth usage of the reseller's accounts during the queried period, in bytes.
    - `year` integer — The queried year.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 1 | 0 — * `1` — Success. * `0` — Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)