Account Management API
Bandwidth stats for a zone
- Proxy
- Proxy Manager
- Web Unlocker & SERP API
- Web Scraper IDE API
- Web Scraper API
- Scraping Shield
- Account Management API
- POSTAdd a Zone
- POSTWhitelist/Blacklist Domain(s)
- POSTBlacklist IP(s)
- POSTWhitelist IP(s)
- POSTAdd Static IP(s)
- POSTMigrate Static IPs between zones
- POSTRefresh dedicated residential IPs
- POSTRefresh Static IPs (Datacenter/ISP)
- PUTChange Account Status
- GETAccount status
- GETActive Zones
- GETAvailable IPs/Zone
- GETAvailable Datacenter & ISP IPs count
- GETGet Countries
- GETGet Country Cities
- GETGet current service status
- GETList all available country's cities (static network)
- GETRecent IPs attempting to use your Zone
- GETAvailable Datacenter & ISP IPs/Zone
- GETBandwidth stats for a zone
- GETBandwidth stats for all your zones
- GETTotal cost & bandwidth for a zone
- GETList of blacklisted IPs for a zone
- GETList of whitelisted IPs for a zone
- GETLive status of Static Zone
- GETTotal Balance
- GETZone info
- GETZone Password
- GETZone Permission
- GETZone Statistics
- GETZone status
- GETGet Proxies Pending Replacement
- DELRemove dedicated residential IPs
- DELRemove domain from Zone whitelist/blacklist
- DELRemove IP from Zone blacklist
- DELRemove IP from Zone whitelist
- DELRemove Static IPs (Datacenter/ISP)
- DELRemove a Zone
- POSTSwitch 100% uptime
- POSTTurn on/off Zone
- POST
- Marketplace Dataset API
Account Management API
Bandwidth stats for a zone
Get the bandwidth stats for a Zone
GET
/
zone
/
bw
curl --request GET \
--url https://api.brightdata.com/zone/bw \
--header 'Authorization: Bearer <token>'
{
"ID:": {
"customer_id": "customer_id",
"from": "2022-10-01T00:00:00.000Z",
"to": "2022-11-23T00:00:00.000Z",
"data": {
"static": {
"bw_sum": [
0,
745,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
6960,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"bw_dn": [
0,
525,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
5990,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"bw_up": [
0,
220,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
970,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"http_direct_req": [
0,
1,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"bw_sum_dc": [
0,
745,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
6960,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"bw_api": [
0,
745,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
6960,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"https_direct_req": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
1,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
}
},
"last_value_ts": "2022-11-19T19:1* Connection #0 to host brightdata.com left intact 8:51.546Z",
"last_update_ts": "2022-11-22T11:35:32.122Z",
"sums": {
"static": {
"back_m1": {
"bw_sum": 745,
"bw_dn": 525,
"bw_up": 220,
"http_direct_req": 1,
"bw_sum_dc": 745,
"bw_api": 745,
"https_direct_req": 0
},
"back_m0": {
"bw_sum": 6960,
"bw_dn": 5990,
"bw_up": 970,
"http_direct_req": 0,
"bw_sum_dc": 6960,
"bw_api": 6960,
"https_direct_req": 1
},
"back_d2": {
"bw_sum": 0,
"bw_dn": 0,
"bw_up": 0,
"http_direct_req": 0,
"bw_sum_dc": 0,
"bw_api": 0,
"https_direct_req": 0
},
"back_d1": {
"bw_sum": 0,
"bw_dn": 0,
"bw_up": 0,
"http_direct_req": 0,
"bw_sum_dc": 0,
"bw_api": 0,
"https_direct_req": 0
},
"back_d0": {
"bw_sum": 0,
"bw_dn": 0,
"bw_up": 0,
"http_direct_req": 0,
"bw_sum_dc": 0,
"bw_api": 0,
"https_direct_req": 0
}
}
}
}
}
Paste your API token to the authorization field. To get a token, Create an account and learn how to generate a token
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Response
200 - application/json
OK
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://api.brightdata.com/zone/bw \
--header 'Authorization: Bearer <token>'
{
"ID:": {
"customer_id": "customer_id",
"from": "2022-10-01T00:00:00.000Z",
"to": "2022-11-23T00:00:00.000Z",
"data": {
"static": {
"bw_sum": [
0,
745,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
6960,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"bw_dn": [
0,
525,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
5990,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"bw_up": [
0,
220,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
970,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"http_direct_req": [
0,
1,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"bw_sum_dc": [
0,
745,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
6960,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"bw_api": [
0,
745,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
6960,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"https_direct_req": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
1,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
}
},
"last_value_ts": "2022-11-19T19:1* Connection #0 to host brightdata.com left intact 8:51.546Z",
"last_update_ts": "2022-11-22T11:35:32.122Z",
"sums": {
"static": {
"back_m1": {
"bw_sum": 745,
"bw_dn": 525,
"bw_up": 220,
"http_direct_req": 1,
"bw_sum_dc": 745,
"bw_api": 745,
"https_direct_req": 0
},
"back_m0": {
"bw_sum": 6960,
"bw_dn": 5990,
"bw_up": 970,
"http_direct_req": 0,
"bw_sum_dc": 6960,
"bw_api": 6960,
"https_direct_req": 1
},
"back_d2": {
"bw_sum": 0,
"bw_dn": 0,
"bw_up": 0,
"http_direct_req": 0,
"bw_sum_dc": 0,
"bw_api": 0,
"https_direct_req": 0
},
"back_d1": {
"bw_sum": 0,
"bw_dn": 0,
"bw_up": 0,
"http_direct_req": 0,
"bw_sum_dc": 0,
"bw_api": 0,
"https_direct_req": 0
},
"back_d0": {
"bw_sum": 0,
"bw_dn": 0,
"bw_up": 0,
"http_direct_req": 0,
"bw_sum_dc": 0,
"bw_api": 0,
"https_direct_req": 0
}
}
}
}
}