# cPanel API 2 Functions - Stats::getmonthlybandwidth

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

This function displays a domain's monthly bandwidth statistics.

Warning:
We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists.

## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Stats&cpanel_jsonapi_func=getmonthlybandwidth
```

Note:
For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Retrieve monthly bandwidth statistics for example.com
$get_monthly_bandwidth = $cpanel->api2(
    'Stats', 'getmonthlybandwidth'
    )
 );
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


```undefined syntaxhighlighter-pre
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Retrieve monthly bandwidth statistics for example.com
my $get_monthly_bandwidth = $cpliveapi->api2(
    'Stats', 'getmonthlybandwidth',

 );
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) system to call the cPanel APIs. Examples are **only** present in order to help developers move from the old cPanel tag system to our [LiveAPI](/guides/guide-to-the-liveapi-system).
- cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
- For more information, read our [Deprecated cPanel Tag Usage](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username Stats getmonthlybandwidth
```

div
Notes:

- You **must** URI-encode values.
- `username` represents your account-level username.
- You **must** include the `--user=username` option.
- For more information and additional output options, read our [Guide to cPanel API 2](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "getmonthlybandwidth",
    "data": [
      {
        "bw": {
          "imap": 3386
        },
        "date": "2014-04"
      },
      {
        "bw": {
          "http": 672
        },
        "date": "2014-10"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Stats"
  }
}
```

Note:
Use cPanel's *[API Shell](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

This function does not accept parameters.

## Returns

table
colgroup
col
col
col
col
col
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
bw
td
em
hash
td
p
A hash of the type and amount of bandwidth data that the account uses.
td
p
This hash includes the 
code
http
, 
code
ftp
, 
code
imap
, 
code
smtp
, and 
code
date
 returns.
td
br
tr
td
p
code
http
td
em
integer
td
p
The amount HTTP bandwidth, in bytes.
p
The function returns this value in the 
code
bw
 hash.
td
A positive integer.
td
code
672
tr
td
p
code
ftp
td
em
integer
td
p
The amount FTP bandwidth, in bytes.
p
span
The function returns this value in the 
code
bw
span
 hash.
td
A positive integer.
td
code
345
tr
td
p
code
imap
td
em
integer
td
p
The amount IMAP bandwidth, in bytes.
p
span
The function returns this value in the 
code
bw
span
 hash.
td
A positive integer.
td
code
3386
tr
td
p
code
smtp
td
em
integer
td
p
The amount of SMTP bandwidth, in bytes.
p
span
The function returns this value in the 
code
bw
span
 hash.
td
A positive integer.
td
code
875
tr
td
p
code
date
td
em
string
td
p
The month of the bandwidth type's last transfer, in 
code
YYYY-MM
 format.
p
span
The function returns this value in the 
code
bw
span
 hash.
td
p
A date in 
code
YYYY-MM
 format, where:
ul
li
code
YYYY
 represents the four-digit year.
li
code
MM
 represents the two-digit date.
td
code
2014-04
tr
td
code
reason
td
em
string
td
p
A reason for failure.
p
This function only returns a 
code
reason
 value if there was an error.
td
span
A string that describes the error.
td
span
span
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1