Skip to main content

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

KeyTypeDefinition
tokenstringUnique identifier for the proxy token
usernamestringUsername for proxy authentication
authTypestringAuthentication type for the proxy
passwordstringPassword for proxy authentication
proxyTypestringType of proxy server
authenticatedIpsarray[string]Array of IPv4 addresses allowed to use this proxy (used when authType is "ip"). Maximum 4 IP addresses allowed.
proxiesarray[string]List of proxy server addresses in format "IP:PORT"
durationHoursnumberNumber of hours until the token expires
statusstringCurrent status of the token. "active" = ready for use, "expired" = ran out of duration hours, "deleted" = manually deleted via DELETE API call, "processing" = being created
createdAtnumberUnix timestamp when the token was created
updatedAtnumberUnix timestamp when the token was last updated
dataUsagenumberTotal data usage in bytes for this token
regionstringRegion of the token
productstringProduct identifier for the token, as provided by the Get ISP Stock endpoint. Subnet products end with "_24" and require quantity=254 when creating tokens.
quantitynumberNumber 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