Get residential data
How much residential IP data your account has left, what your plan includes this month, the price of 1 GB, the most one purchase can add, how much more can be added today, why it can’t buy now, and what you bought.
price_cents as expected_price_cents. See Residential IP.
403 with code ACCOUNT_KEY_REQUIRED, and a share-link guest 403 with GUEST_RESTRICTED.left_bytescounts data bought and this month’s included data. It is the network’s count atcounted_at, less what the computers reported since, so it is an estimate between counts. While data can’t be added, or once the account reached its limit for the day, this month’s included data not added yet is left out of it and shows asincluded.waiting_bytes.includedis what the plan includes this UTC month: 1 GB on Starter, 5 GB on Growth, 20 GB on Scale and Enterprise. It is used before data bought, comes back in full atresets_at, and does not roll over. If the plan ends, pauses or switches before then, the amount follows that plan from that day.included.left_bytescan be a little more thangb_per_month, as data is added in whole GB.includedis absent on a plan with none, such as Free. A plan on a trial includes none until the trial ends, andincluded_after_trialsays what it will include each month from then.max_gbis the most one purchase can add now, in whole GB: at most 100, and at mostdaily_gb_left, so 20 or less for most accounts. It is less while the network has less to add, and 0 while nothing can be added. It follows the network’s newest count, so read it just before you buy. Send anygbfrom 1 to it to Buy residential data.daily_gb_limitis the account’s limit of residential data added a UTC day: 20 GB for most accounts. Every way data is added counts together: purchases from credits, card payments, auto-buy and the plan’s included data, which is added a GB at a time as it is used.daily_gb_leftis what the limit leaves today. Both are null where no limit applies. The limit is on adding data, not using it: data the account already has can still be used.card_availableis true when a person signed in to Orgo can pay by card in Settings → Plan & billing. It is always false with an API key, which can’t pay by card.purchaseslists the last 20, newest first. Apendingpurchase has its credits held, not spent; areturnedone was not added, and its credits went back.auto_buy.availableisfalsewhile auto-buy isn’t offered, which is the case today.auto_buyis set by a person in Settings → Plan & billing, never by a key. It buys nothing until the account has bought once by hand (terms_accepted).
Why it can’t buy
can_buy is false with a buy_blocked_reason. The first reason that applies, in this order, is the one you read:
needs_billing only takes the place of a buy the key alone stops. Any other reason stays as it is, since a key with Billing write would meet it too. buy_opens_at is present with day_limit and daily_data_limit only.Authorizations
Response
The account’s residential data.
Data left: bought, and this month’s included data. As the network last counted it, less what the computers reported since, never below zero. An estimate between counts. While data can’t be added (buy_blocked_reason unavailable), or once the account reached its limit for the day (daily_data_limit), this month’s included data not added yet is left out: it is included.waiting_bytes instead.
Why can_buy is false, the first that applies in this order. Null when can_buy is true. unavailable: nobody can add data to this account right now: for example the network has none to add, residential data is blocked for the account, the account is being deleted, or a refund or dispute isn’t settled. Paying, adding credit or a computer won’t help, so try later. daily_data_limit: the account was added its limit of GB for the UTC day (daily_gb_limit), every way together: purchases from credits, card payments, auto-buy and the plan’s included data. More can be added at buy_opens_at, the next 00:00 UTC, and nothing lifts it sooner. The limit is on adding data, not using it. no_computer: no Linux computer outside Bops for the data to run on, on a free account too. Add one first. day_limit: the account made its 10 purchases of the UTC day. Each purchase from credits and each card payment started counts, paid or not. Buy again at buy_opens_at, the next 00:00 UTC. not_paying: no paid plan and no credit bought. Starting credit alone can’t buy residential data: pay by card signed in to Orgo, or add credit first. Once the account has paid, its whole balance pays, starting credit included. credit_short: the credits don’t cover 1 GB. needs_billing: this key has no Billing write, and nothing else stops the buy. Use a key with Billing write, or Orgo itself. Any other reason stays as it is, since a key with Billing write would meet it too.
unavailable, daily_data_limit, no_computer, day_limit, not_paying, credit_short, needs_billing, null A person signed in to Orgo can pay for data by card in Plan and billing, also with no paid plan and no credit bought (not_paying). False with an API key, which can’t pay by card. can_buy and buy_blocked_reason still say whether a purchase can go now. Absent while it is not for sale.
The most one purchase can add now, in whole GB: at most 100, and at most daily_gb_left where the account has a daily limit, so 20 or less for most accounts. Less while the network has less to add, and 0 while nothing can be added. It follows the network’s newest count, so read it just before you buy. Absent while it is not for sale.
x >= 0The account’s limit of residential data added a UTC day, in whole GB: 20 for most accounts. Every way data is added counts together: purchases from credits, card payments, auto-buy and the plan’s included data. Null where no limit applies. Absent while it is not for sale.