Documentation

1. Get a key

Issue a gateway key from the keys page. It is shown once.

curl -sS -X POST https://162.35.242.76.nip.io/api/v1/keys \
  -H "Authorization: Bearer $ORBIT_KEY"

2. Point your client at the gateway

Any standard proxy client works. HTTP CONNECT:

curl --proxy http://$ORBIT_KEY@gateway.orbit.example:1080 \
  https://ifconfig.me

Or SOCKS5:

curl --proxy socks5h://$ORBIT_KEY@gateway.orbit.example:1080 \
  https://ifconfig.me

socks5h (not socks5) sends the hostname to the gateway, so resolution happens there and your traffic does not leak a DNS request locally.

3. Sticky sessions

Send an X-Orbit-Session header to pin a source IP for up to 10 minutes on Pro and Business.

curl --proxy http://$ORBIT_KEY@gateway.orbit.example:1080 \
  -H "X-Orbit-Session: checkout-42" \
  https://ifconfig.me   # same exit IP for 10 minutes

4. Live usage API

curl -sS https://162.35.242.76.nip.io/api/v1/live \
  -H "Authorization: Bearer $ORBIT_KEY"

Returns open connections, distinct exit nodes and the concurrency limit.

5. Response codes

Status	Meaning	What to do
407	Missing or invalid key	Check the Authorization header
402	Account suspended or over quota	Check /api/v1/usage
429	Concurrency limit reached	Back off, or raise your plan limit
502	No consented node available	Retry; add X-Orbit-Region

Node consent

Exit nodes run an app that shows a persistent, non-dismissable indicator while it is participating, displays the current session on the device home screen, and can be switched off by the owner at any time without contacting us. Node owners receive a share of the traffic they carry.