---
title: "Generate Proxy List By Search"
method: GET
path: "/public/user/proxy/list_by_search"
tags: ["Proxy"]
---

# Generate Proxy List By Search

`GET /public/user/proxy/list_by_search`

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 purposes.

## Query parameters

- `list_protocol` 'http' | 'socks5'
- `list_version` 'ipv4' | 'ipv6'
- `list_format` 'standard' | 'http' | 'socks5' | 'socks5h'
- `proxy_user_id` string
- `list_authentication` 'username_and_password' | 'ip_address' | 'proxy_specific'
- `proxy_id` integer
- `service_id` string
- `proxy_ip_address` string
- `subnet_id` string
- `subnet_id_v6` string
- `ip_address_id_v4` string
- `ip_address_id_v6` string
- `http_formatted` string
- `proxy_http_port` integer
- `proxy_socks5_port` integer
- `proxy_status` 'available' | 'in_use' | 'reserved' | 'waiting' | 'pending_deletion'
- `proxy_type` 'isp' | 'datacenter' | 'residential' | 'mobile'
- `proxy_protocol` 'ipv4' | 'ipv6' | 'dual'
- `country_id` string
- `country_name` string
- `subdivision_id` string
- `subdivision_name` string
- `city_id` integer
- `city_name` string
- `city_timezone` string
- `city_example_postcode` string
- `city_latitude` string
- `city_longitude` string
- `asn_id` string
- `asn_name` string
- `proxy_last_update_datetime` string, date-time
- `per_page` integer
- `page` integer
- `sort_by` string

## Response `200`

Successfully generated proxy list.

- object
  - `data` string[] — List of proxies.
  - `message` string — Success message.

---

[API](https://skmtc.dev/byteful/apis/byteful-public-user-api.md) · [All operations](https://skmtc.dev/byteful/apis/byteful-public-user-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/byteful/byteful-public-user-api/revisions/3db1a6fc0099/schema)