Skip to main content
GET
Get residential proxy
Returns the computer’s browser route and the account’s residential data. See Residential IP. exit_ip is the last IP seen. Add ?check=1 to read it through the proxy now. The answer then adds changed and checked_at. A check uses a few KB of data, and a computer allows 6 a minute. proxy_on is also true when the computer uses your own proxy, so read mode to tell them apart.

Data fields

quota is the workspace owner’s data, shared by every computer of theirs. On a Linux computer set to the residential route, other than a Bops computer, the answer also carries: billing.buy_blocked_reason is the first of these that applies, in this order: billing.payer is true when the caller is the owner, signed in or with an account-wide key that has full access or Billing write. billing.card_available is true when the owner, signed in to Orgo, can pay by card, also with not_paying. It is always false with an API key, which can’t pay by card. included is present when the owner’s plan includes data each month: gb_per_month, used_bytes this UTC month, and resets_at, when it comes back in full. If the plan ends, pauses or switches before then, the amount follows that plan from that day. A plan on a trial includes none until the trial ends. While data can’t be added, or once the account reached its limit for the day, this month’s included data not added yet can’t be used. included.waiting_bytes says how much, and quota.granted_bytes and quota.remaining_bytes leave it out until it is added. computer_blocked_reason is present when this computer can’t use a residential IP whatever data the account has: bops_computer, dedicated_ip, or paused. Buying data doesn’t help while it is set. This call never spends.

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 relay now and adds changed and checked_at. Uses a few KB of data. 6 checks a minute per computer.

Available options:
1

Response

The computer's browser route and the account's data.

Which route the computer’s Chrome leaves through, its exit IP, and the account’s residential data. state, billing, quota.counted_at and quota.this_computer_bytes are present on a Linux computer set to the residential route, and never on a Bops computer. included is present when the owner’s plan includes data.

mode
enum<string>
required

The computer's browser route. residential is the default. custom is your own proxy, set with POST /api/computers/{id}/egress/upstream (see Browser networking); with it, turning the relay on uses your proxy, not a residential IP.

Available options:
residential,
device,
custom
proxy_on
boolean
required

Whether Chrome goes through the relay. It is also true on a custom route, which is not a residential IP, so read mode too.

exit_ip
string | null
required

The address websites see from Chrome, as last read. Null while the relay is off or before it was read.

country
string
required

The exit country. Only us for now.

quota
object
required

The workspace owner’s residential data. Every computer of the workspace owner draws on it.

computer_blocked_reason
enum<string>

Why this computer can’t use a residential IP whatever data the account has: a Bops computer, a dedicated IP that is on, or residential IPs paused for this computer. Absent when nothing stops it. Buying data does not help while it is set.

Available options:
bops_computer,
dedicated_ip,
paused
state
enum<string>

Where the account’s data stands. none: the account has never had any. ok: some left. low: under 0.25 GB left. buying: a purchase is still finishing. out: none left, so Chrome can’t load pages until there is more. Present on a Linux computer set to the residential route, and never on a Bops computer.

Available options:
none,
ok,
low,
buying,
out
billing
object

Whether more data can be bought now. Present with state. It carries no balance: Get residential data has that, for the owner.

included
object

The data the owner’s plan includes this UTC month, used before data bought. Absent on a plan with none, such as Free, and on a plan on a trial until the trial ends.

changed
boolean

With check=1: whether the exit IP differs from the last reading.

checked_at
string<date-time>

With check=1: when the exit IP was read.