Skip to content

Get residential sub-user traffic

GET
/proxies/residential/subusers/{childId}/package
curl --request GET \
--url https://api.ltesocks.io/v2/proxies/residential/subusers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/package \
--header 'Authorization: Bearer <token>'

Requires an active linked top-level Master or Regular account and enabled residential sub-user management. Slave accounts cannot manage children. Send Authorization: Bearer . Token ability: proxy.residential.subusers.package (or *). Returns the child and package identifiers, allocated quota, consumed traffic and remaining traffic in bytes.

childId
required
string format: uuid

LTESocks UUID of a sub-user belonging to the authenticated parent.

Get residential sub-user traffic succeeded.

Media typeapplication/json
object
success
required
boolean
code
required
integer
data
required
object
id
string format: uuid
package_id
string format: uuid
traffic_bytes
integer format: int64
nullable
used_bytes
integer format: int64
nullable
remaining_bytes
integer format: int64
nullable
Examples
Exampleresponse
{
"success": true,
"code": 200,
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"package_id": "22222222-2222-4222-8222-222222222222",
"traffic_bytes": 1073741824,
"used_bytes": 0,
"remaining_bytes": 1073741824
}
}

Missing or invalid bearer token.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}

Inactive or unsupported account, insufficient token ability, or child ownership denied.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}

Sub-user or linked residential account not found, or residential sub-user management is disabled.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}

Conflicting operation or duplicate user.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}

Invalid input, insufficient available traffic, incompatible package, or quota limit exceeded.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}

Request rate limit exceeded.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}

Internal service error.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}

Residential service failed or its result could not be read.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}

Residential service temporarily unavailable.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}