> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.byteful.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Scenarios

> Collection of practical examples for the Byteful API

## Practical Examples

Explore these practical examples to learn how to effectively use the Byteful API for common tasks and workflows.

<CardGroup cols={2}>
  <Card title="Retrieving All Proxies" icon="server" href="/api-examples/retrieving-all-proxies">
    Learn how to retrieve and paginate through all your proxies and add them to a list.
  </Card>

  <Card title="Export All Static Proxies" icon="file-export" href="/api-examples/export-all-static-proxies">
    Export your datacenter and ISP proxies to a list using the list\_by\_search endpoint.
  </Card>

  <Card title="Retrieve Proxies from a Service" icon="server" href="/api-examples/retrieving-all-proxies-from-service">
    Learn how to retrieve all proxies associated with a specific service ID.
  </Card>

  <Card title="Export Proxies from a Service" icon="file-export" href="/api-examples/export-all-proxies-from-service">
    Export a formatted list of proxies from a specific service.
  </Card>

  <Card title="Generate Residential Proxies" icon="users" href="/api-examples/generate-residential-proxies-sticky-us">
    Generate a list of sticky residential proxies in the US for a specific proxy user.
  </Card>

  <Card title="Generate Mobile Proxies" icon="mobile" href="/api-examples/generate-mobile-proxies-sticky-us">
    Generate a list of sticky mobile proxies in the US for a specific proxy user.
  </Card>

  <Card title="Create a Proxy User" icon="user-plus" href="/api-examples/create-a-proxy-user">
    Create a proxy user with metadata and data limits.
  </Card>

  <Card title="Create Proxy User with Service Access" icon="user-lock" href="/api-examples/create-proxy-user-with-service-access">
    Create a proxy user with restricted access to specific services using ACLs.
  </Card>

  <Card title="Create Proxy User with Proxy Access" icon="shield-halved" href="/api-examples/create-proxy-user-with-proxy-access">
    Create a proxy user with access to specific individual proxies using ACLs.
  </Card>

  <Card title="Manage Proxy User ACLs" icon="list-check" href="/api-examples/manage-proxy-user-acls">
    Search, add, and remove Proxy User ACL entries to control access.
  </Card>

  <Card title="Retrieve All Proxies for a Proxy User" icon="user" href="/api-examples/retrieve-all-proxies-for-a-proxy-user">
    Learn how to retrieve all proxies a proxy user can access based on their ACL settings.
  </Card>

  <Card title="Search Proxy User by Metadata" icon="database" href="/api-examples/search-proxy-user-by-metadata">
    Search for proxy users using metadata criteria.
  </Card>

  <Card title="Edit Proxy User Metadata" icon="database" href="/api-examples/edit-proxy-user-metadata">
    Search for proxy users using metadata criteria.
  </Card>

  <Card title="Purchasing with API" icon="cart-plus" href="/api-examples/purchasing-with-api">
    Learn how to automate proxy purchasing through our API.
  </Card>

  <Card title="Retrieve Analytics for Proxy User" icon="chart-line" href="/api-examples/retrieve-analytics-for-proxy-user">
    Learn how to access and analyze usage statistics for a specific proxy user.
  </Card>

  <Card title="Edit Proxy User Authentication" icon="key" href="/api-examples/edit-proxy-user-authentication">
    Update authentication credentials and settings for an existing proxy user.
  </Card>

  <Card title="Test a list of proxies" icon="microscope" href="/api-examples/create-proxy-test-run">
    Test a list of proxies from a file and output the results to a csv.
  </Card>
</CardGroup>

## Implement Your Own Integrations

These examples are written in multiple programming languages to help you implement your own integrations with the Byteful API. Each example includes:

* Detailed explanation of the API functionality
* Code samples in Python, JavaScript, PHP, Go, and Java
* Sample API responses
* Best practices and tips

## Need Custom Examples?

If you need help with specific use cases not covered in these examples, please contact our support team or join our Discord community for assistance.

<CardGroup cols={2}>
  <Card title="Contact Developer Support" icon="headset" href="mailto:developers@byteful.com">
    Reach out to our support team for technical assistance.
  </Card>
</CardGroup>