Skip to content
Rayobyte Docs

All parameters

One page with every option. The detail pages explain when to reach for each.

Targeting

Section titled “Targeting”
Option Password form Header Values
Country -country-US X-Rayobyte-Country ISO 3166-1 alpha-2, 2 letters
State or region -region-texas X-Rayobyte-Region Letters, _, .
City -city-dallas X-Rayobyte-City Letters, _, .
ZIP code -zip-75201 X-Rayobyte-Zip 2–10 letters or digits
ASN -asn-7018 X-Rayobyte-Asn 1–10 letters or digits
Device OS -os-windows X-Rayobyte-Os 1–16 letters or digits
IPv4 only -v4 — No value
IPv6 only -v6 — No value

Sessions

Section titled “Sessions”
Option Password form Header Values
Soft sticky -session-abc123 X-Rayobyte-Session 1–16 letters or digits
Strict sticky -hardsession-abc123 X-Rayobyte-Hardsession 1–16 letters or digits
Duration -duration-30 X-Rayobyte-Duration 1–120 minutes, clamped

Rules that apply to all of them

Section titled “Rules that apply to all of them”

Options go on the password, never the username.

USERNAME:[email protected]:8000

Order does not matter. -country-US-city-dallas and -city-dallas-country-US are the same request.

Hyphens separate options. A value can never contain one. Multi-word values use an underscore: -region-new_york, -city-los_angeles.

Headers beat the password form when you send both for the same option.

SOCKS5 has no headers. Use the password form there.

Unsupported options are ignored, not rejected. Sending -city- to Rotating ISP does not error and does not narrow anything. Check Feature availability.

Out-of-range values are clamped, not rejected. -duration-500 becomes 120. You get no warning.

A full example

Section titled “A full example”
Terminal window
curl -x 'USERNAME:PASSWORD-country-US-region-texas-city-dallas-os-windows-session-abc12345-duration-30@us-east.gw.rayobyte.com:8000' \
  https://api.ipify.org

The header equivalent:

Terminal window
curl --proxy-header "X-Rayobyte-Country: US" \
     --proxy-header "X-Rayobyte-Region: texas" \
     --proxy-header "X-Rayobyte-City: dallas" \
     --proxy-header "X-Rayobyte-Os: windows" \
     --proxy-header "X-Rayobyte-Session: abc12345" \
     --proxy-header "X-Rayobyte-Duration: 30" \
     -x us-east.gw.rayobyte.com:8000 https://api.ipify.org

Was this page helpful?