# Byteful Documentation ## Docs - [Authentication](https://documentation.byteful.com/api-basics/authentication.md): Authenticating with the Byteful API - [Error Handling](https://documentation.byteful.com/api-basics/error-handling.md): Understanding and handling errors in the Byteful API - [Rate Limiting](https://documentation.byteful.com/api-basics/rate-limiting.md): Understanding and working with API rate limits - [Structure](https://documentation.byteful.com/api-basics/structure.md): Understanding the Byteful API structure, URL patterns, HTTP methods, and data formats - [API Changelog](https://documentation.byteful.com/api-changelog.md): What we've changed and added to Byteful. A straightforward timeline of our improvements. - [Metadata](https://documentation.byteful.com/api-core-features/metadata.md): Using and working with metadata in the Byteful API - [Pagination](https://documentation.byteful.com/api-core-features/pagination.md): Working with paginated responses in the Byteful API - [Filter Operators](https://documentation.byteful.com/api-core-features/search-operators.md): Advanced filtering with operators in the Byteful API - [Sorting](https://documentation.byteful.com/api-core-features/sorting.md): Controlling result order with the sort_by parameter in the Byteful API - [Analytics and Usage Tracking](https://documentation.byteful.com/api-explainers/analytics.md): Understanding the analytics, logging, and tracking systems in the Byteful API - [Purchasing via API](https://documentation.byteful.com/api-explainers/api-purchasing.md): How to programmatically purchase and manage proxies through the Byteful API - [Billing Cycles & Credit System](https://documentation.byteful.com/api-explainers/billing.md): Understanding billing cycles and the credit system in the Byteful API - [Common Object Relationships](https://documentation.byteful.com/api-explainers/common-object-relationships.md): Understanding how proxy objects relate to geographic and network entities in the Byteful API - [Proxy Testing Overview](https://documentation.byteful.com/api-explainers/proxy-tester.md): How proxy testing works on the Byteful API. - [Proxy Types Overview](https://documentation.byteful.com/api-explainers/proxy-types.md): This guide explains the different proxy types available through Byteful, helping you choose the right option for your needs. - [Proxy User Access Control](https://documentation.byteful.com/api-explainers/proxy-user-access-control.md): Understanding and implementing granular access control for your proxy users - [Residential & Mobile Data](https://documentation.byteful.com/api-explainers/residential-mobile-data.md): Understanding and managing residential/mobile data allocation in the Byteful API - [Service Adjustments Explained](https://documentation.byteful.com/api-explainers/service-adjustments.md): Understanding the service adjustment audit trail in the Byteful API - [API Introduction](https://documentation.byteful.com/api-introduction.md): Welcome to the Byteful API documentation - [ASN](https://documentation.byteful.com/api-objects/asn.md): Understanding the ASN object and its role in the Byteful API - [City](https://documentation.byteful.com/api-objects/city.md): Understanding the City object and its role in the Byteful API - [Continent](https://documentation.byteful.com/api-objects/continent.md): Understanding the Continent object and its role in the Byteful API - [Country](https://documentation.byteful.com/api-objects/country.md): Understanding the Country object and its role in the Byteful API - [Customer](https://documentation.byteful.com/api-objects/customer.md): Understanding the Customer object and its role in the Byteful API - [Log](https://documentation.byteful.com/api-objects/log.md): Understanding the Log object and its role in the Byteful API - [Log Summary](https://documentation.byteful.com/api-objects/log-summary.md): Understanding the Log Summary object and its role in the Byteful API - [Mobile Ledger](https://documentation.byteful.com/api-objects/mobile-ledger.md): Understanding the Mobile Ledger object and its role in the Byteful API - [Product](https://documentation.byteful.com/api-objects/product.md): Understanding the Product object and its role in the Byteful API - [Proxy](https://documentation.byteful.com/api-objects/proxy.md): Understanding the Proxy object and its role in the Byteful API - [Proxy Testing](https://documentation.byteful.com/api-objects/proxy-tester.md): Understanding the Proxy Tester and its role in the Byteful API - [Proxy User](https://documentation.byteful.com/api-objects/proxy-user.md): Understanding the Proxy User object and its role in the Byteful API - [Proxy User ACL](https://documentation.byteful.com/api-objects/proxy-user-acl.md): Understanding the Proxy User ACL object and its role in access control - [Residential Ledger](https://documentation.byteful.com/api-objects/residential-ledger.md): Understanding the Residential Ledger object and its role in the Byteful API - [Service](https://documentation.byteful.com/api-objects/service.md): Understanding the Service object and its role in the Byteful API - [Service Adjustment](https://documentation.byteful.com/api-objects/service-adjustment.md): Understanding the Service Adjustment object and its role in the Byteful API - [Subdivision](https://documentation.byteful.com/api-objects/subdivision.md): Understanding the Subdivision object and its role in the Byteful API - [Retrieve ASN](https://documentation.byteful.com/api-reference/asn/retrieve-asn.md): Retrieves a specific ASN. - [Search ASN](https://documentation.byteful.com/api-reference/asn/search-asn.md): Search Autonomous System Number (ASN) entries using various filters. - [Create Checkout](https://documentation.byteful.com/api-reference/checkout/create-checkout.md): This endpoint creates a checkout for the authenticated user based on the provided data. It supports different payment platforms, promotional codes, and can handle both one-time and recurring payments. You can either specify a `product_code` directly or supply the traditional combination of `product_… - [Generate Checkout Quote](https://documentation.byteful.com/api-reference/checkout/generate-checkout-quote.md): This endpoint allows a user to generate a quote for a service via the API. You can either specify a `product_code` directly or use the traditional combination of `product_type`, `country_id`, and `product_protocol`. - [Retrieve Simplified Product Checkout Catalog](https://documentation.byteful.com/api-reference/checkout/retrieve-simplified-product-checkout-catalog.md): This endpoint returns a simplified product list that is both visible and enabled for API checkouts. It helps clients to quickly identify and purchase available products without any search or pagination parameters. Ideal for basic API-based purchasing. - [Retrieve City](https://documentation.byteful.com/api-reference/city/retrieve-city.md): Retrieves a specific City. - [Search City](https://documentation.byteful.com/api-reference/city/search-city.md): Search City entries using various filters. - [Retrieve Continent](https://documentation.byteful.com/api-reference/continent/retrieve-continent.md): Retrieves a specific Continent. - [Search Continent](https://documentation.byteful.com/api-reference/continent/search-continent.md): Search Continent entries using various filters. - [Retrieve Country](https://documentation.byteful.com/api-reference/country/retrieve-country.md): Retrieves a specific Country. - [Search Country](https://documentation.byteful.com/api-reference/country/search-country.md): Search Country entries using various filters. - [Retrieve Current Customer](https://documentation.byteful.com/api-reference/customer/retrieve-current-customer.md): Retrieves the profile of the currently authenticated customer, along with their credit balance. - [Get Mobile Availability Count](https://documentation.byteful.com/api-reference/mobile-availability/count-mobile-availability.md): Get the total count of mobile availability nodes with optional filtering capabilities. Filters are applied when parameters are present and not null. - [Search Mobile Availability](https://documentation.byteful.com/api-reference/mobile-availability/search-mobile-availability.md): Search mobile availability records with optional grouping capabilities. Use `group_by` parameter to aggregate results by specified field(s). - [Retrieve Mobile Ledger](https://documentation.byteful.com/api-reference/mobile-ledger/retrieve-mobile-ledger.md): Retrieves a specific Mobile Ledger based on the provided ID for the current user's account. - [Search Mobile Ledger](https://documentation.byteful.com/api-reference/mobile-ledger/search-mobile-ledger.md): Search for entries in the Mobile Ledger using various filters. - [Generated Mobile List](https://documentation.byteful.com/api-reference/mobile/create-mobile-list.md): This endpoint creates a list of mobile proxies based on filter parameters. The search parameters allow the user to filter the proxies by location, session type, and format (e.g., http, socks5, socks5h). - [Retrieve Mobile Service Summary](https://documentation.byteful.com/api-reference/mobile/retrieve-mobile-service-summary.md): This endpoint provides a detailed summary of a mobile service. It returns information such as service details, usage statistics, and associated proxy users. - [Search Product](https://documentation.byteful.com/api-reference/product/search-product.md): Search Products entries using various filters. - [Analytics Breakdown](https://documentation.byteful.com/api-reference/proxy-analytics/breakdown-proxy-analytics.md): This endpoint analyzes proxy usage for a given customer within a specified time range and provides breakdowns by proxy users, hostnames, and network types. - [Graph Proxy Analytics](https://documentation.byteful.com/api-reference/proxy-analytics/graph-proxy-analytics.md): This endpoint analyzes proxy usage for a given customer within a specified time range and groups them by one of four discrete intervals: `minute`, `hour`, `day`, or `month`. - [Create Proxy Test Run](https://documentation.byteful.com/api-reference/proxy-tester/create-proxy-test.md): Test all provided proxies against urls - [Search Proxy Test Servers](https://documentation.byteful.com/api-reference/proxy-tester/search-proxy-test-servers.md): Search Proxy Test Servers using various filters. - [Create Proxy User ACL](https://documentation.byteful.com/api-reference/proxy-user-acl/create-proxy-user-acl.md): This endpoint allows you to create a new Proxy User ACL entry to grant access to specific services or proxies. - [Delete Proxy User ACL Record](https://documentation.byteful.com/api-reference/proxy-user-acl/delete-proxy-user-acl.md): Allows a user to delete an existing Proxy User ACL associated with their account. This permanently removes the ACL record from the database. - [Retrieve Proxy User ACL](https://documentation.byteful.com/api-reference/proxy-user-acl/retrieve-proxy-user-acl.md): Retrieves a specific Proxy User ACL based on the provided ID for the current user's account. - [Search Proxy User ACLs](https://documentation.byteful.com/api-reference/proxy-user-acl/search-proxy-user-acls.md): Search Proxy User ACL entries on the customer account using various filters. Only returns ACL entries for proxy users that belong to the current customer. - [Create Proxy User](https://documentation.byteful.com/api-reference/proxy-user/create-proxy-user.md): This endpoint allows you to create a new proxy user. - [Delete Proxy User Record](https://documentation.byteful.com/api-reference/proxy-user/delete-proxy-user-record.md): Allows a user to delete an existing proxy user associated with their account. Proxy users that are set as account default can not be deleted, and already deleted proxy users can not be deleted again. - [Edit Proxy User](https://documentation.byteful.com/api-reference/proxy-user/edit-proxy-user.md): This endpoint allows a user to edit an existing Proxy User entry by providing the necessary `proxy_user_id`. - [Retrieve Proxy User](https://documentation.byteful.com/api-reference/proxy-user/retrieve-proxy-user.md): Retrieves a specific Proxy User based on the provided ID for the current user's account. - [Search Proxy Users](https://documentation.byteful.com/api-reference/proxy-user/search-proxy-users.md): Search Proxy Users on the customer account using various filters. - [Retrieve Proxy](https://documentation.byteful.com/api-reference/proxy/retrieve-proxy.md): Retrieves a specific Proxy based on the provided ID for the current user's account, ensuring that only proxies associated with the customer services and in use are returned. - [Generate Proxy List By ID](https://documentation.byteful.com/api-reference/proxy/retrieve-proxy-list-by-id.md): This endpoint retrieves a list of proxies assigned to the current user (or a specified customer) based on the proxy IDs. - [Generate Proxy List By Search](https://documentation.byteful.com/api-reference/proxy/retrieve-proxy-list-by-search.md): This endpoint retrieves a list of available proxies for a user based on provided search parameters. The search parameters allow the user to filter the proxies based on protocol, version, format, and associated service ID. The function returns proxies in various formats suitable for different purpose… - [Get Proxy User List Options](https://documentation.byteful.com/api-reference/proxy/retrieve-proxy-list-options.md): This endpoint returns a list of all active proxy users on the customer's account, along with a boolean flag indicating whether each proxy user has access to export/use the specified proxies based on their access type and ACL rules. - [Search Proxies](https://documentation.byteful.com/api-reference/proxy/search-proxies.md): Search Proxies on the customer account using various filters. - [Get Residential Availability Count](https://documentation.byteful.com/api-reference/residential-availability/count-residential-availability.md): Get the total count of residential availability nodes with optional filtering capabilities. Filters are applied when parameters are present and not null. - [Search Residential Availability](https://documentation.byteful.com/api-reference/residential-availability/search-residential-availability.md): Search residential avairecords with optional grouping capabilities. Use `group_by` parameter to aggregate results by specified field(s). - [Retrieve Residential Ledger](https://documentation.byteful.com/api-reference/residential-ledger/retrieve-residential-ledger.md): Retrieves a specific Residential Ledger based on the provided ID for the current user's account. - [Search Residential Ledger](https://documentation.byteful.com/api-reference/residential-ledger/search-residential-ledger.md): Search for entries in the Residential Ledger using various filters. - [Generated Residential List](https://documentation.byteful.com/api-reference/residential/create-residential-list.md): This endpoint creates a list of residential proxies based on filter parameters. The search parameters allow the user to filter the proxies by location, session type, and format (e.g., http, socks5, socks5h). - [Retrieve Residential Service Summary](https://documentation.byteful.com/api-reference/residential/retrieve-residential-service-summary.md): This endpoint provides a detailed summary of a residential service. It returns information such as service details, usage statistics, and associated proxy users. - [Retrieve Service Adjustment](https://documentation.byteful.com/api-reference/service-adjustment/retrieve-service-adjustment.md): Retrieves a specific Service Adjustment based on the provided ID for the current user's account. The returned adjustment provides details about any modifications or updates made to the user's service. - [Search Service Adjustments](https://documentation.byteful.com/api-reference/service-adjustment/search-service-adjustments.md): Search Service Adjustments on the customer account using various filters. - [Cancel Service](https://documentation.byteful.com/api-reference/service/cancel-service.md): Allows the authenticated user to cancel a specific service associated with their account. The user provides a service_id and optionally a cancel feedback and comment. - [Edit Service](https://documentation.byteful.com/api-reference/service/edit-service.md): Allows a user to edit the details of an existing service. This can include changes in payment method, adjusting automatic collection, and marking for cancellation at the end of a period. - [Retrieve Service](https://documentation.byteful.com/api-reference/service/retrieve-service.md): Retrieves a specific Service based on the provided ID for the current user's account. If the 'show_proxies' parameter is set to 'True', it will also fetch proxies associated with each service and add them to the result. - [Search Services](https://documentation.byteful.com/api-reference/service/search-services.md): Search Services on the customer account using various filters. - [Retrieve Subdivision](https://documentation.byteful.com/api-reference/subdivision/retrieve-subdivision.md): Retrieves a specific Subdivision. - [Search Subdivision](https://documentation.byteful.com/api-reference/subdivision/search-subdivision.md): Search Subdivision entries using various filters. This endpoint allows users to query subdivisions based on specific attributes. - [Retrieve Zip Code](https://documentation.byteful.com/api-reference/zip-code/retrieve-zip-code.md): Retrieves a specific Zip Codeq. - [Search Zip Code](https://documentation.byteful.com/api-reference/zip-code/search-zip-code.md): Search Zip Code entries using various filters. - [Scenarios](https://documentation.byteful.com/examples-index.md): Collection of practical examples for the Byteful API - [Abuse Reporting Policy](https://documentation.byteful.com/general/abuse-reporting-policy.md): Official Abuse Reporting Policy and Instructions for Byteful services - [Acceptable Usage Policy](https://documentation.byteful.com/general/acceptable-usage-policy.md): Official Acceptable Usage Policy (AUP) for Byteful services - [Account Registration](https://documentation.byteful.com/general/account-registration.md): How to create and verify your Byteful account - [Fair Usage Policy](https://documentation.byteful.com/general/anti-abuse-policy.md): Understanding our flexible approach to data and connection management - [Billing Address](https://documentation.byteful.com/general/billing-address.md): Learn how to set up and manage your billing address for invoices in Byteful - [Changing your payment cycle](https://documentation.byteful.com/general/changing-payment-cycle.md): Learn how to modify your subscription payment cycle - [Changing your email address](https://documentation.byteful.com/general/changing-your-email-address.md): Learn how to update the email address associated with your Byteful account - [Changing your password](https://documentation.byteful.com/general/changing-your-password.md): Learn how to change your account password in the dashboard - [Creating a Proxy User](https://documentation.byteful.com/general/creating-a-proxy-user.md): Learn how to create and configure proxy users for better organization and access control - [Credit and Payment Transactions](https://documentation.byteful.com/general/credit-and-payment-transactions.md): Learn how to view and understand payment and credit transactions in your Byteful dashboard. - [Debugging Proxy Errors](https://documentation.byteful.com/general/debugging-and-error-codes.md): Learn how to identify and resolve proxy request failures using the Live Log Viewer and `x-byteful-request-id` header. - [Edit Payment Method](https://documentation.byteful.com/general/edit-payment-method.md): Learn how to update your subscription payment method and automatic renewal settings in your Byteful dashboard - [Editing a Proxy User](https://documentation.byteful.com/general/editing-a-proxy-user.md): Learn how to edit your proxy users through the Byteful dashboard - [Ethical Sourcing Guidelines](https://documentation.byteful.com/general/ethical-sourcing.md): Our commitment to ethical proxy sourcing and maintaining the highest standards of compliance and transparency. - [Understanding Mobile Proxies](https://documentation.byteful.com/general/explaining-mobile-proxies.md): Learn about mobile proxies, their benefits, and how they work at Byteful - [Understanding Residential Proxies](https://documentation.byteful.com/general/explaining-residential-proxies.md): Learn about residential proxies, their benefits, and how they work at Byteful - [Forgotten Password](https://documentation.byteful.com/general/forgot-password.md): How to reset your password if you've forgotten it for your Byteful account - [Generating Mobile Proxies](https://documentation.byteful.com/general/generating-mobile-proxies.md): Learn how to generate and use mobile proxies on our platform - [Generating Residential Proxies](https://documentation.byteful.com/general/generating-residential-proxies.md): Learn how to generate and use residential proxies on our platform - [Geolocation Targeting](https://documentation.byteful.com/general/geolocation-targeting.md): How to target specific countries and cities with residential proxies - [Geolocation Targeting](https://documentation.byteful.com/general/geolocation-targeting-mobile.md): How to target specific countries and cities with mobile proxies - [Integrating on Android or iOS](https://documentation.byteful.com/general/integration/android-iphone.md): Learn how to use Byteful on mobile devices, including setup recommendations for iOS and Android. - [Integrating with a Browser](https://documentation.byteful.com/general/integration/browser-integrations.md): Learn how to integrate Byteful services with popular browsers. - [ClonBrowser](https://documentation.byteful.com/general/integration/clonbrowser.md) - [cURL](https://documentation.byteful.com/general/integration/curl.md) - [DICloak](https://documentation.byteful.com/general/integration/dicloak.md) - [DuckDuckGo](https://documentation.byteful.com/general/integration/duckduckgo.md) - [FoxyProxy](https://documentation.byteful.com/general/integration/foxyproxy.md) - [GoLogin](https://documentation.byteful.com/general/integration/gologin.md) - [Hayha](https://documentation.byteful.com/general/integration/hayha.md) - [ixBrowser](https://documentation.byteful.com/general/integration/ixbrowser.md) - [Lauth](https://documentation.byteful.com/general/integration/lauth.md) - [Microsoft Edge](https://documentation.byteful.com/general/integration/microsoft-edge.md) - [MuLogin](https://documentation.byteful.com/general/integration/mulogin.md) - [Multilogin](https://documentation.byteful.com/general/integration/multilogin.md) - [Nstbrowser](https://documentation.byteful.com/general/integration/nstbrowser.md) - [Octo Browser](https://documentation.byteful.com/general/integration/octobrowser.md) - [Proxifier](https://documentation.byteful.com/general/integration/proxifier.md) - [Proxy SwitchyOmega](https://documentation.byteful.com/general/integration/proxy-switchyomega.md) - [Safari](https://documentation.byteful.com/general/integration/safari.md) - [SessionBox](https://documentation.byteful.com/general/integration/sessionbox.md) - [Shadowrocket](https://documentation.byteful.com/general/integration/shadowrocket.md) - [Undetectable Browser](https://documentation.byteful.com/general/integration/undetectable-browser.md) - [VMLogin](https://documentation.byteful.com/general/integration/vmlogin.md) - [Invoices](https://documentation.byteful.com/general/invoices.md): Learn how to view, pay, and download your invoices in the Byteful dashboard. - [ISP / ASN Targeting](https://documentation.byteful.com/general/isp-asn-targeting.md): Learn how to target specific internet service providers and ASNs with Byteful - [ISP / ASN Targeting](https://documentation.byteful.com/general/isp-asn-targeting-mobile.md): Learn how to target specific internet service providers and ASNs with Byteful - [Know Your Customer Policy](https://documentation.byteful.com/general/kyc-policy.md): Our comprehensive Know Your Customer (KYC) policy ensuring compliance and maintaining high ethical standards. - [Listing and Exporting Proxies](https://documentation.byteful.com/general/listing-and-exporting-proxies.md): How to view, filter, and export your static proxies - [Live Network Activity](https://documentation.byteful.com/general/live-network-activity.md): Learn how to use the real-time proxy debugging interface in the Byteful dashboard to monitor and troubleshoot requests as they happen. - [Products & Purchasing](https://documentation.byteful.com/general/making-your-first-purchase.md): Discover and purchase proxy services from the Byteful dashboard - [Observability Overview](https://documentation.byteful.com/general/observability-overview.md): Learn how to monitor and analyze proxy usage across hostnames, users, and networks with the Byteful Observability Panel - [Proxy Authentication Types](https://documentation.byteful.com/general/proxy-authentication-types.md): Understanding and choosing between different proxy authentication methods - [Refund Policy](https://documentation.byteful.com/general/refund-policy.md): Understanding our refund policy and eligibility requirements for Byteful services - [Resizing your service](https://documentation.byteful.com/general/resizing-your-service.md): Learn how to resize and reconfigure your Byteful services - [Restricted Domains](https://documentation.byteful.com/general/restricted-domains.md): Understanding domain restrictions in the Byteful network - [Service Cancellation](https://documentation.byteful.com/general/service-cancellation.md): Learn how to cancel or pause your Byteful subscriptions, including Datacenter, Static Residential, Mobile Data and Residential Data services. - [Datacenter Proxies](https://documentation.byteful.com/general/static-datacenter-proxies.md): Understanding datacenter proxies, their benefits, and limitations - [Proxy Replacement Policy](https://documentation.byteful.com/general/static-proxy-replacements.md): Understanding our policy for proxy replacements and how to handle replacement events - [Static Residential ISP Proxies](https://documentation.byteful.com/general/static-residential-isp-proxies.md): Understanding Static Residential ISP Proxies, their capabilities, and advantages - [Sticky vs Rotating Mobile Proxies](https://documentation.byteful.com/general/sticky-vs-rotating-mobile-proxies.md): Understanding the differences between sticky and rotating mobile proxies and their use cases - [Sticky vs Rotating Residential Proxies](https://documentation.byteful.com/general/sticky-vs-rotating-residential-proxies.md): Understanding the differences between sticky and rotating residential proxies and their use cases - [Store Credit](https://documentation.byteful.com/general/store-credit.md): Learn how to add and use store credit for your Byteful account - [Sub-Processors](https://documentation.byteful.com/general/sub-processors.md): List of third-party sub-processors that Byteful uses to provide our services - [Supported Protocols](https://documentation.byteful.com/general/supported-protocols.md): Protocol support information for Byteful services - [Two-factor Authentication (2FA)](https://documentation.byteful.com/general/two-factor-authentication.md): Learn how to secure your account with Two-factor Authentication (2FA) - [Using Smartpath®](https://documentation.byteful.com/general/using-smartpath.md): Learn about Smartpath, its benefits, and how it optimizes your residential proxy usage at Byteful - [Using Smartpath®](https://documentation.byteful.com/general/using-smartpath-mobile.md): Learn about Smartpath, its benefits, and how it optimizes your mobile proxy usage at Byteful - [What is a Proxy?](https://documentation.byteful.com/general/what-is-a-proxy.md): A beginner-friendly guide to understanding proxies, how they work, and their most common use cases - [Introduction](https://documentation.byteful.com/introduction.md): Your comprehensive guide to Byteful services, tools, and resources - [Need Help?](https://documentation.byteful.com/need-help.md): If you can not find something you need in this knowledge base, our support team is here to help. - [Product Update Log](https://documentation.byteful.com/product-updates.md): What we've changed and added to Byteful. A straightforward timeline of our improvements. ## OpenAPI Specs - [openapi](https://documentation.byteful.com/api-reference/openapi.json) - [proxy-tester-routes](https://documentation.byteful.com/api-reference/proxy-tester-routes.json)