---
title: "Return reseller's information"
method: GET
path: "/resellerstats"
tags: ["Resellers", "Account Settings"]
---

# Return reseller's information

`GET /resellerstats`

This function lists data about a reseller's accounts.

## Query parameters

- `user` string, username, required
- `filter_deleted` 0 | 1
- `filter_suspended` 0 | 1
- `month` integer
- `year` integer

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `reseller` object — Object containing data about a reseller account.
      - `acct` object[] — Array of objects that contains data about all of the reseller's accounts. **Note:** This array also returns the reseller account.
        - `bandwidthlimit` string — The account's bandwidth limit. * A positive numeric value, encoded as a string, that represents the account's bandwidth limit, in megabytes (MB). * `0.00` — The account has unlimited bandwidth.
        - `bandwidthused` string — The account's current bandwidth use. A positive numeric value, encoded as a string, that represents the account's bandwidth use, in megabytes (MB).
        - `deleted` 0 | 1 — Whether the account has been deleted. * `1` — Deleted. * `0` — **Not** deleted.
        - `diskquota` string — The account's disk space quota. * A positive numeric value, encoded as a string, that represents the account's disk space quota, in megabytes (MB). * `0.00` — The account has unlimited disk space.
        - `diskused` string — The account's current disk space use. A positive numeric value, encoded as a string, that represents the account's current disk space use, in megabytes (MB).
        - `domain` string, domain — The account's main domain.
        - `package` string — The account's hosting plan (package).
        - `suspended` 0 | 1 — Whether the account is suspended. * `1` — Suspended. * `0` — Not suspended.
        - `user` string, username — The account's username.
      - `bandwidthlimit` integer — The reseller's total bandwidth limit. * A positive integer that represents the reseller's bandwidth limit, in megabytes (MB). * `0` — The reseller has unlimited bandwidth.
      - `bwoverselling` 0 | 1 — Whether the reseller can oversell bandwidth. * `1` — The reseller can oversell bandwidth. * `0` — The reseller **cannot** oversell bandwidth.
      - `diskoverselling` 0 | 1 — Whether the reseller can oversell disk space. * `1` — The reseller can oversell disk space. * `0` — The reseller **cannot** oversell disk space.
      - `diskquota` integer — The reseller's total disk space quota. * A positive integer that represents the reseller's disk space quota, in megabytes (MB). * `0` — The reseller has unlimited disk space.
      - `diskused` number — The total amount of disk space that the reseller and all of its accounts use, in megabytes (MB). **Note:** This value does not include disk space the reseller account uses if the root account owns it.
      - `month` integer — The current month or a queried month.
      - `totalbwalloc` string — The total amount of bandwidth that the reseller has given to its accounts, in megabytes (MB), encoded as a string.
      - `totalbwused` string — The total amount of bandwidth that the reseller's accounts have used, in megabytes (MB), encoded as a string.
      - `totaldiskalloc` string — The total amount of disk space that the reseller has given to its accounts, in megabytes (MB), encoded as a string.
      - `user` string, username — The reseller account's username.
      - `year` integer — The current year or a 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` 0 | 1 — * `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)