Skip to main content
GET
Get residential IP status
Returns whether this computer’s Google Chrome goes out through a residential IP, the last exit IP Orgo saw, and the account’s residential data.
Replace $COMPUTER_ID with the computer’s UUID.

Check the exit IP now

Add ?check=1 to test the route or see whether the IP has moved. The computer reads its exit IP through the proxy, and exit_ip is that reading. The answer adds changed, which is true when the reading differs from the last exit IP Orgo saw, and checked_at.
You can check 6 times a minute per computer. Past that the answer is 429 with the code rate_limited. A check spends a few KB of the account’s data. A check answers 409 when the proxy is off, when the computer is asleep (code computer_asleep), or when no reading came back. The IP on record stands, so try again. An IP lasts up to 2 hours and can change sooner, as How long a residential IP lasts explains.

Read the data left

quota is the workspace owner’s residential data, shared by every computer in the account. It is DataImpulse’s count as of Orgo’s last hourly sync, so it can be up to an hour behind.

Authorizations

Authorization
string
header
required

API key authentication. Get your key at orgo.ai/workspaces

Path Parameters

id
string
required

Computer ID. Accepts the computer's UUID or its instance_id.

Query Parameters

check
enum<string>

1 reads the exit IP through the proxy now and adds changed and checked_at. Omit it to get the last exit IP Orgo saw.

Available options:
1

Response

The status. With ?check=1, exit_ip is that reading.

A computer's residential IP and the account's residential data.

proxy_on
boolean
required

true while this computer's Chrome goes through the proxy.

exit_ip
string | null
required

The last exit IP Orgo saw. null while the proxy is off, or if Orgo could not read one.

country
string
required

The exit country: us.

quota
object
required

The workspace owner's residential data, shared by every computer in the account. DataImpulse's count as of Orgo's last hourly sync, so it can be up to an hour behind.

changed
boolean

Only with ?check=1: this reading differs from the last exit IP Orgo saw.

checked_at
string<date-time>

Only with ?check=1: when it was read.