.ikp-floating-button {
  background: #C9FC75;
  color: #34383C;
  z-index: 100000;
}

Features

Proxy Management

Platform Status

Contact Support

Bytio

Zones

Account

Guides

API Reference

Sign up

Log in

Returns information about your Bytio Account such as what Plan you are on, billing and spend information.

Account information

An object returning the address information set on the account, as-entered in the Billing page of the Dashboard. This information is displayed on all monthly invoices generated by Bytio.

An object returning the status of your account balance.

The amount, in cents, of your current account balance not including `trial_amount_cents` (i.e. excluding any free trial balance). Note that fractional cents are returned here but the platform rounds up to 2 decimal places for billing purposes.

The amount, in cents, of your current account balance including any remaining free trial balance. Note that fractional cents are returned here but the platform rounds up to 2 decimal places for billing purposes.

The amount, in cents, of your remaining free trial credit. If you have fully used your free trial credit, or it has expired, then `trial_amount_cents` will be set to `null`. Note that fractional cents are returned here but the platform rounds up to 2 decimal places for billing purposes.

The UTC date and time that your free trial credit expires, in ISO 8601 format. If you have fully used your free trial credit, or it has expired, then `trial_expires_on` will be set to `null`.

The UTC date and time the of the pending account closure when `status=pending_account_closure`, in ISO 8601 format. If the account is not pending closure the `pending_account_closure_date` key is not present.

The UTC date and time the of the pending plan downgrade when `status=pending_downgrade_plan`, in ISO 8601 format. If the account is not pending a plan downgrade the `pending_downgrade_plan_date` key is not present.

The ID of the plan the account is pending downgrade to when `status=pending_downgrade_plan`.

An object returning your spend within the current month and whether the minimum monthly spend criteria of your plan (if your account is not on the Pay As You Go plan) has been met.

The amount, in cents, that your account has spend in the current billing period (i.e. the current month). Note that fractional cents are returned here but the platform rounds up to 2 decimal places for billing purposes.

If your account is on a monthly plan `minimum_monthly_spend_met` will be set to `true` if you have met the minimum monthly spend for your plan in the current month. Set to `false` otherwise. If your account is on the Pay As You Go plan then `minimum_monthly_spend_met` will be `null`. You can check `plan.minimum_monthly_spend_cents` to view the minimum monthly spend for your current plan.

If your account has been upgraded in the current month, then `prorata_amount_cents` represents the spend that has occurred on the current plan and excludes the spend that may have occurred on your previous plan. If your account has not been upgraded within the current month then `prorata_amount_cents` will be `null`. Note that fractional cents are returned here but the platform rounds up to 2 decimal places for billing purposes.

The status of the Bytio account.

`active` means there are no issues with the account and it`s currently active.

`unverified` if you have signed up but not verified your email, and therefore can`t make proxy requests through zones (to remedy this you should verify your email on the Profile page of the Dashboard).

`insufficient_balance` when your account balance is too too low to cover the usage and/or standing (time-based) charges for your provisioned zones (to remedy this you should add funds to your account balance either via the API or on the Billing page of the Dashboard). 

`insufficient_plan_minimum_spend` if your payment method failed when Bytio attempted to collect your minimum monthly spend amount (if you`re on a pay-monthly plan).

`pending_account_closure` when your account has been set to close at the end of the current billing cycle. See `pending_account_closure_date` for the date the account closure will occur.

`pending_downgrade_plan` when your account has been set to downgrade to a lower plan at the end of the current billing cycle. See `pending_downgrade_plan_date` for the date the downgrade will occur and `pending_downgrade_plan_id` for the ID of the plan the account will be downgraded to.

`suspendeed` means the account is currently suspended and in-review by the Bytio team. An account will enter this status where potential abuse (such as attempting to open multiple Free Trials) is detected. Contact the Bytio team for more information about restoring an account in the `suspended` state.


An object returning the status of the Know Your Customer (KYC) identity verification process. You can learn more about the Bytio KYC process here - https://docs.bytio.com/account/kyc

The UTC date and time that your account completed the Know Your Customer (KYC) identity verification process.

Set to `true` when the account is on the Pay As You Go plan (the default for new accounts) or `false` otherwise.

The minimum monthly spend required by the plan the account is currently on. If the account is on the Pay As You Go plan then `minimum_monthly_spend_cents` will be set to `0`.

The human-readable name of the plan the account is currently on.

The UTC date and time the of the next plan payment date, in ISO 8601 format. If the account is on the Pay As You Go plan then `next_payment_date` will be set to `null`. The Bytio billing cycle follows the calendar month so `next_payment_date` is typically midnight on the first day of the next month.

The ID of the plan the account is currently on.

Populated when the account has changed plan (upgraded) within the current billing cycle, set to `null` otherwise. `prorata_minimum_monthly_spend_cents` shows the pro-rated, lower, minimum monthly spend required for the current month. For example, if an account is upgraded to a plan with a minimum monthly spend of $10 halfway through the month, on the 15th, then `prorata_minimum_monthly_spend_cents` would be `500` ($5).

The API key (also used as the proxy zone password) of the user making the request.

The email address of the user making the request, as set on the Profile page of the dashboard.

The name of the user making the request, as set on the Profile page of the dashboard.

A URL to the avatar image for the user making the request. If no avatar is set for the user then `picture` is set to `null`.

The role the user making the request is in. The role a user is set to defines their permissions. See the Docs for more information https://docs.bytio.com/account/roles

The ID of the team that the user making the request belongs to.

ApiKeyAuth

The root URL from which the API is served.

Bytio provides low cost, high performance proxy infrastructure for web data collection at scale.

Introduction

Documentation

Learn how to get started with Bytio, create your first zone and retrieve proxy credentials.

Getting started

About zones

Proxy networks

Retrieve proxy connection details for your zone in a variety of formats

Connection details

Parameters

Bytio allows you to route requests through IPs in multiple countries.

Countries

Zones set up on the Reserved datacenter proxy network allow you to reserve IPs in an IP pool dedicated to your account.

Reserved IPs

Exclusivity

The more flexible billing in the industry. Pay per-GB or per-simultaneous connection (thread).

Billing methods

Sessions allow you to re-use the same datacenter IP, residential proxy or mobile device across multiple requests (also referred to as _sticky sessions_). This can be useful if you want efficiently use the same IP until it is blocked by your target website.

Sessions

Use zone alerts to manage your spend and be alerted when spend or consumption thresholds are near.

Alerts

You can disable a zone to prevent proxy requests going through it, but keep it's configuration intact.

Disabled zones

In order to keep the Bytio platform free to malicious activity we actively block certain websites.

Restricted targets

Information on the response codes issued by a proxy request made via Bytio.

Response codes

If your account balance has insufficient funds you'll be prompted before creating a zone.

Insufficient funds

If there is a payment issue on your Bytio account your zones will be deprovisioned after a grace period.

Deprovisioned zones

Waiting for approval

Partially provisioned

The shared datacenter proxy network is comprised of thousands of IPs across multiple subnets with a new IP assigned on each request you make.

Datacenter IP pool size

The mobile proxy network is comprised of a network of real mobile devices.

Mobile network IP pool size

The residential proxy network is comprised of a network of real residential internet connections globally.

Residential network IP pool size

Supported ports and protocols

Overview

Account & team

We provide one of the most extensive Free Trials in the industry to allow you to fully evaluate the Bytio service risk-free.

Free Trial

Invite team members to easily share your Bytio account with colleagues.

Team members

A team members' role determines their permissions.

Roles

Learn about our KYC process designed be quick to complete and keep our platform and customers safe.

Identity Verification (KYC)

Update email address

Reset password

Bytio provides full visibility over your usage and spend per month, so you're always in control.

Usage and spend

API key

Notifications about activity on your Bytio account can be viewed on the dashboard or sent to your email.

Notifications

Determine whether you'd like to receive emails about activity on your Bytio account.

Email preferences

Connected accounts allows you to link your account with social providers (Google or Github) for easier login.

Connected accounts

Account balance

Learn how to top up your account balance.

Top up

Low balance alerts

We're confident you'll find Bytio a great partner for your proxy requirements.

Refund policy

Stick with industy-leading Pay As You Go pricing or opt for a monthly minimum-spend plan to unlock even lower costs.

Monthly plans

If you're on a monthly minimum spend plan you may see a Balancing charge on your monthly invoice.

Balancing charges

Invoices & payment receipts

Supported payment methods

Payment issues

Account in review

Why is my invoice $0.00?

Restricted countries

Interact with your Bytio account programmatically, create and edit proxy zones and administer your account using the API.

API reference

Learn about rate limits and how to adhere to them.

Rate limits

Returns a list of zones that match the supplied search parameters and are visible to the user.

Search zones

Creates a new zone using the parameters passed in the body of the request.

You can also create a zone on the [dashboard](https://docs.bytio.com/zones/about-zones).

Creating a zone may result in charges being made against your account balance, these charges are detailed in the `cost` response object. For example, if the create operation results in provisioning a reserved datacenter zone subject to per-IP charges. In the event of the available account balance being insufficient an `HTTP 402 Payment Required` response will be returned.

> 📘 Previewing zone charges
> 
> To preview any charges required to create the zone use the `preview` query parameter. When `preview=true` the proposed new zone is returned in the `zone` response object and any associated charges are returned in the `cost` response object, but no changes are actually committed. This is useful to `dry run` creating a zone and view its` cost impact, before committing to the zone create operation.


Create a zone

Permanently deletes multiple zones (up to a maximum of 100 per-request). It cannot be undone. Also immediately stops any proxy requests through the zones from succeeding.

Delete multiple zones

Get zones

Updates the specified zone by setting the values of the parameters passed in the body of the request. Any parameters not provided will be left unchanged.

Some parameters are nullable and can be unset by passing `null` as the parameter value. For example, if you pass `null` for the `countries` parameter, then the zone will have the countries setting removed.

Updating a zone may result in charges being made against your account balance, these charges are detailed in the `cost` response object. For example, if the update operation results in provisioning a larger `pool_size` in a reserved datacenter zone. In the event of the available account balance being insufficient an `HTTP 402 Payment Required` response will be returned.

> 📘 Preview zone changes
> 
> To preview changes to a zone before committing them use the `preview` query parameter. When `preview=true` the changes to the zone are returned in the `zone` response object and any associated charges are returned in the `cost` response object, but no changes are actually committed. This is useful to `dry run` changes to a zone and view their cost impact, before committing to the change.


Update a zone

Permanently deletes a zone. It cannot be undone. Also immediately stops any proxy requests through this zone from succeeding.

Delete a zone

Retrieves the IPs of a `datacenter` zone. Only valid when `ip_type` is `reserved`.

Get zone IPs

Refreshes (replaces with a new IP) one or more IPs from a `datacenter` zone. Only valid when `ip_type` is `reserved`.

Refresh zone IPs

Deletes one or more IPs from a `datacenter` zone. Only valid when `ip_type` is `reserved`.

Delete zone IPs

Retrieves a list of generated proxy credentials (connection details) for the given zone.

Get proxy zone credentials

Returns a list of users (referred to as Team Members on the Bytio dashboard) that match the supplied search parameters. Only Administrators (users in the `admin` role) are able to access the users API endpoints.

Search users

Get users

Retrieves billing history for your Bytio account. You can use this endpoint to retrieve payment reciepts and monthly invoices.

Billing history

Cancels a pending scheduled plan downgrade, if your account currently has a pending plan downgrade scehduled.

Cancel downgrade

Cancels a pending account closure, if your account is currently has a pending closure scehduled.

Cancel account closure

Returns information about your Bytio Account such as what Plan your account is on, billing and spend information.

List plans

Learn how to set up your Bytio proxy [zones](/zones/about-zones) in third party software apps and services.

Guide for setting up Bytio proxies in the SwitchyOmega [Chrome](https://chromewebstore.google.com/detail/proxy-switchyomega/padekgcemlokbadohgkifijomclgjgif) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/switchyomega) browser extension.

Introduction

Zones

Zones IPs

Zone proxy credentials

Users

Account

Plans

Account information

Authorizations

Response