Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.turnoxy.com/llms.txt

Use this file to discover all available pages before exploring further.

Append parameters to the username with - delimiter: 
{username}-{param}-{value}-{param}-{value}:{password}@{host}:{port}

​
Quick Reference

ParameterValuesDefaultDescription
countryISO 3166-1 alpha-2randomCountry code
statelowercase + underscore-State/province (requires country)
citylowercase + underscore-City name (requires country)
session4-20 alphanumeric-Session ID for sticky IP
ttl1-6030Session duration (minutes)
timeout1-12030Connection timeout (seconds)

​
country

ISO 3166-1 alpha-2 country code.
CodeCountryCodeCountry
USUnited StatesJPJapan
GBUnited KingdomDEGermany
CACanadaAUAustralia
FRFranceSGSingapore
sub_xxx-country-US:pass@gate.turnoxy.com:1318

​
state

State or province. Requires country. Format: lowercase, underscores for spaces (new_york, california) 
sub_xxx-country-US-state-california:pass@gate.turnoxy.com:1318

​
city

City name. Requires country. Format: lowercase, underscores for spaces (los_angeles, new_york) 
sub_xxx-country-US-city-los_angeles:pass@gate.turnoxy.com:1318

# With state for precision
sub_xxx-country-US-state-california-city-los_angeles:pass@gate.turnoxy.com:1318
If city conflicts with state, the system falls back to state-level targeting.

​
session

Keep the same IP across requests.
ModeParametersBehavior
Rotating(none)New IP each request
StickysessionSame IP for 30 min
Sticky + TTLsession + ttlSame IP for specified duration
Timed Rotationttl onlyAuto-rotate every N minutes
# Sticky session
sub_xxx-session-order123:pass@gate.turnoxy.com:1318

# Sticky with custom TTL
sub_xxx-session-order123-ttl-10:pass@gate.turnoxy.com:1318

​
ttl

Session duration in minutes (1-60). Default: 30. 
sub_xxx-session-task01-ttl-15:pass@gate.turnoxy.com:1318

​
timeout

Connection timeout in seconds (1-120). Default: 30. 
sub_xxx-timeout-60:pass@gate.turnoxy.com:1318

​
Complete Example

sub_xxx-country-US-state-california-city-los_angeles-session-task01-ttl-15-timeout-60:pass@gate.turnoxy.com:1318
See Errors for validation errors.