---
title: "Search Proxies"
method: GET
path: "/public/user/proxy/search"
tags: ["Proxy"]
---

# Search Proxies

`GET /public/user/proxy/search`

Search Proxies on the customer account using various filters.

## Query parameters

- `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
- `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
- `proxy_user_id` string
- `per_page` integer
- `page` integer
- `sort_by` string

## Response `200`

Successful Proxy search

- object — Proxy search was successful.
  - `data` object[] — Array of Proxy items matching the search criteria up to the limit of per_page paramater.
    - `asn_id` integer
    - `asn_name` string
    - `city_example_postcode` string
    - `city_id` integer
    - `city_latitude` number
    - `city_longitude` number
    - `city_name` string
    - `city_timezone` string
    - `country_id` string
    - `country_name` string
    - `customer_id` integer
    - `default_proxy_user_password` string
    - `default_proxy_user_username` string
    - `ip_address_id_v4` string
    - `ip_address_id_v6` string
    - `proxy_http_port` integer
    - `proxy_id` string
    - `proxy_ip_address` string
    - `proxy_ip_address_v6` string
    - `proxy_last_update_datetime` string, date-time
    - `proxy_password` string
    - `proxy_protocol` 'ipv4' | 'ipv6' | 'dual'
    - `proxy_socks5_port` integer
    - `proxy_status` 'available' | 'in_use' | 'reserved' | 'waiting' | 'pending_deletion'
    - `proxy_type` 'datacenter' | 'isp' | 'residential' | 'mobile'
    - `proxy_user_ids` string[]
    - `proxy_username` string
    - `service_id` string
    - `subdivision_id` string
    - `subdivision_name` string
    - `subnet_id` string
    - `subnet_id_v6` string
    - `http_formatted` string
    - `socks5_formatted` string
  - `item_count` integer — Total number of Proxy items returned in the data field.
  - `message` string — Status message for the search.
  - `page` integer — Current page number of the search results returned.
  - `per_page` integer — Number of Proxy items returned per page.
  - `total_count` integer — Total of Proxy items that match the search filter.

---

[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)