.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

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

Billing history

Present when `type=card` and returns the brand of the payment card. Key is absent otherwise.

If `type=paypal` then `email` returned the email address associated with the PalPal account.

Present when `type=card` and returns the expiry month of the payment card (`1` being January, `12` being December). Key is absent otherwise.

Present when `type=card` and returns the 4-digit expiry year of the payment card. Key is absent otherwise.

Present when `type=card` and returns the 4-digits of the payment card. Key is absent otherwise.

The type of payment method.

`card` the stored payment method is a card (see `brand` for the brand of card).
`paypal` the stored payment method is PayPal.


Present when `type=card` and returns the name of the wallet the payment card was set up via - i.e. Apple Pay, Google Pay. Key is absent otherwise.

The UTC date and time the of the billing history entry, in ISO 8601 format.

Only present when `type=invoice`. A link to download the invoice in PDF format.

Only present when `type=invoice`. Returns the human-readable name of the invoice, typically the month and year the invoice relates to.

Only present when `type=payment`. The type of payment:

`manual_top_up` for top up payments made via the Dashboard.


Only present when `type=payment`. A link to download the reciept in PDF format.

Only present when `type=invoice`. The amount, in cents, of the invoice that relates to standing (i.e. time-based) charges such as IP reservations). Note that fractional cents are returned here but the platform rounds up to 2 decimal places for billing purposes.

Only present when `type=payment`. The outcome of the payment:

`succeeded` the payment was successful.
`failed` the payment failed.


Only present when `type=invoice`. The total amount, in cents, of tax charged on the invoice (if applicable in your jurisdiction). Note that fractional cents are returned here but the platform rounds up to 2 decimal places for billing purposes.

If`type=invoice` `total_cents` returns the total amount, in cents, of the invoice.

If`type=payment` `total_cents` returns the total amount, in cents, of the payment. 

Note that fractional cents are returned here but the platform rounds up to 2 decimal places for billing purposes.


The type of billing history entry:

`invoice` for monthly invoices.
`payment` for payment reciepts (for account balance top ups).


Only present when `type=invoice`. The amount, in cents, of the invoice that relates to usage (i.e. bandwidth) charges. Note that fractional cents are returned here but the platform rounds up to 2 decimal places for billing purposes.

The current page of results, as-determined by the `page` parameter.

The total number of results, across all pages.

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 IP 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

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

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

Account information

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

Billing history

Authorizations

Query Parameters

Response