Proxy Token Schema: Complete Data Structure Reference
The token object is the core object representing a proxy plan. Every field is documented with validation rules and default values.
Token Object Schema
| Key | Type | Definition |
|---|---|---|
| token | string | Unique identifier for the proxy token |
| username | string | Username for proxy authentication |
| authType | string | Authentication type for the proxy |
| password | string | Password for proxy authentication |
| proxyType | string | Type of proxy server |
| authenticatedIps | array[string] | Array of IPv4 addresses allowed to use this proxy (used when authType is "ip"). Maximum 4 IP addresses allowed. |
| proxies | array[string] | List of proxy server addresses in format "IP:PORT" |
| durationHours | number | Number of hours until the token expires |
| status | string | Current status of the token. "active" = ready for use, "expired" = ran out of duration hours, "deleted" = manually deleted via DELETE API call, "processing" = being created |
| createdAt | number | Unix timestamp when the token was created |
| updatedAt | number | Unix timestamp when the token was last updated |
| dataUsage | number | Total data usage in bytes for this token |
| region | string | Region of the token |
| product | string | Product identifier for the token, as provided by the Get ISP Stock endpoint. Subnet products end with "_24" and require quantity=254 when creating tokens. |
| quantity | number | Number of proxies in the token. For subnet products (products ending with "_24"), this value must be 254. |
JSON Example of a Token
{
"token": "zu8sBXS4gkh7",
"username": "kGyohRdaGo",
"authType": "user",
"password": "bkXBberMQ7",
"proxyType": "http",
"authenticatedIps": [],
"proxies": [
"123.123.123.123:12345",
"123.123.111.111:8888"
],
"durationHours": 720,
"status": "active",
"createdAt": 1752251968,
"updatedAt": 1754843968,
"region": "US",
"product": "TICK",
"quantity": 2,
"dataUsage": 11574848653
}
Working with Tokens
Now that you understand the token data structure, explore the API endpoints to manage your tokens:
Token Operations
- Get ISP Stock - Check available products and regions before creating tokens
- Create Token - Create a new proxy token
- Renew Token - Extend token duration by 720 hours
- Retrieve Token - Get detailed information about a token
- Delete Token - Permanently deactivate a token
- List All Tokens - View all tokens filtered by status