---
title: "Residential overview"
method: GET
path: "/v4/account/{subAccountId}/residential/overview"
tags: ["Residential"]
---

# Residential overview

`GET /v4/account/{subAccountId}/residential/overview`

## Request

- Base URL: `https://api.proxyscrape.com`
- URL: `https://api.proxyscrape.com/v4/account/{subAccountId}/residential/overview`
- Auth: API key in header `api-token`
- TypeScript: <https://skmtc.dev/proxyscrape/apis/proxyscrape-account-api/docs/v4/account/:subAccountId/residential/overview/get.ts> (a function with typed inputs; its response is checked against the schema)

Get residential subscription overview: plan, bandwidth used/remaining, status. Permission: `residential:read`.

## Path parameters

- `subAccountId` string, uuid, required

## Response `200`

Residential overview

- object
  - `plan` string
  - `bandwidth_used` integer
  - `bandwidth_limit` integer
  - `status` string

---

[API](https://skmtc.dev/proxyscrape/apis/proxyscrape-account-api.md) - [All operations](https://skmtc.dev/proxyscrape/apis/proxyscrape-account-api/llms.txt) - [OpenAPI document](https://skmtc.dev/proxyscrape/apis/proxyscrape-account-api/revisions/4e10267785e1?raw)