Sign in

v1

latestOpenAPI 3.0.12026-07-265331168.0 KB
Proxy

Search Proxies

Search Proxies on the customer account using various filters.

get/public/user/proxy/search

Query parameters

proxy_idinteger

ID of the proxy

service_idstring

Service ID associated with the proxy

proxy_ip_addressstring

Main IP Address of the proxy

subnet_idstring

Main subnet of the proxy

subnet_id_v6string

Main subnet of the proxy

ip_address_id_v4string

IPv4 address ID of the proxy

ip_address_id_v6string

IPv6 address ID of the proxy

proxy_http_portinteger

http port of the proxy

proxy_socks5_portinteger

socks5 port of the proxy

proxy_status'available' | 'in_use' | 'reserved' | 'waiting' | 'pending_deletion'

Current status of the proxy

proxy_type'isp' | 'datacenter' | 'residential' | 'mobile'

Type of the proxies you want returned in the search

proxy_protocol'ipv4' | 'ipv6' | 'dual'

Version of the proxies you want returned in the search

country_idstring

ISO Country Code (ISO 3166-1 alpha-2)

country_namestring

Name of the country the proxy is located in

subdivision_idstring

ISO Country Code (ISO 3166-2)

subdivision_namestring

Name of the subdivision the proxy is located in

city_idinteger

ID of the city the proxy is located in

city_namestring

Name of the city the proxy is located in

city_timezonestring

Timezone of the City the proxy is located in

city_example_postcodestring

Example postcode of the City the proxy is located in

city_latitudestring

Latitude of the City the proxy is located in

city_longitudestring

Longitude of the City the proxy is located in

asn_idstring

Unique identifier of the ASN of the proxy

asn_namestring

Name associated with the ASN of the proxy

proxy_last_update_datetimestring date-time

Datetime the proxy was last updated

proxy_user_idstring

Filter proxies by proxy user access. Only returns proxies that the specified proxy user has access to.

per_pageinteger

Number of items per page for pagination

pageinteger

Page number for pagination

sort_bystring

Key for sorting or random.

Response

Successful Proxy search

item_countinteger

Total number of Proxy items returned in the data field.

messagestring

Status message for the search.

pageinteger

Current page number of the search results returned.

per_pageinteger

Number of Proxy items returned per page.

total_countinteger

Total of Proxy items that match the search filter.

Example response

{
  "data": [
    {
      "asn_id": 7018,
      "asn_name": "AT&T Enterprises, LLC",
      "city_example_postcode": "75202",
      "city_id": 75202,
      "city_latitude": 32.7767,
      "city_longitude": -96.797,
      "city_name": "Dallas",
      "city_timezone": "America/Chicago",
      "country_id": "us",
      "country_name": "United States",
      "customer_id": 1955,
      "default_proxy_user_password": "apple1984",
      "default_proxy_user_username": "stevejobs",
      "ip_address_id_v4": "107.225.73.142",
      "ip_address_id_v6": "2600:1000:b12a:6351:8523:997e:93c4:f124",
      "proxy_http_port": 8080,
      "proxy_id": "7a018d34-76c2-4c23-b14d-f7b9a7054e25",
      "proxy_ip_address": "107.225.73.142",
      "proxy_ip_address_v6": "2600:1000:b12a:6351:8523:997e:93c4:f124",
      "proxy_last_update_datetime": "2024-03-12 09:30:00",
      "proxy_password": "DHf3PSQXQ7rw1v9",
      "proxy_protocol": "ipv4",
      "proxy_socks5_port": 1080,
      "proxy_status": "in_use",
      "proxy_type": "isp",
      "proxy_user_ids": [
        "stevejobs"
      ],
      "proxy_username": "att7018user",
      "service_id": "API-1234-5678",
      "subdivision_id": "us-tx",
      "subdivision_name": "Texas",
      "subnet_id": "107.225.72.0/22",
      "subnet_id_v6": "2600:1000::/28"
    }
  ],
  "item_count": 1,
  "message": "Proxy search successful.",
  "page": 1,
  "per_page": 10,
  "total_count": 1
}