v1

latestOpenAPI 3.0.12026-07-265331168.0 KB

Residential

Retrieve Residential Service Summary

This endpoint provides a detailed summary of a residential service. It returns information such as service details, usage statistics, and associated proxy users.

get/public/user/residential/summary

Response

Successful retrieval of residential service summary.

messagestring

Example response

{
  "data": {
    "proxy_user_ids": [
      "stevejobs"
    ],
    "residential_bytes": 10024144,
    "residential_bytes_left": 7003114,
    "residential_bytes_used": 3021030,
    "residential_requests": 5012
  },
  "message": "Residential summary successfully generated."
}