Sign in

v1

latestOpenAPI 3.0.12026-07-265331168.0 KB
Proxy

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

get/public/user/proxy/list_by_search

Query parameters

list_protocol'http' | 'socks5'

Desired protocol for the proxies you want returned in the search list.

list_version'ipv4' | 'ipv6'

IP version preference.

list_format'standard' | 'http' | 'socks5' | 'socks5h'

Desired format for displaying the proxies you want returned in the search.

proxy_user_idstring

ID of the proxy_user you want to use to authenticate with the proxies

list_authentication'username_and_password' | 'ip_address' | 'proxy_specific'

Authentication ID for the proxies you want returned in the search.

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

http_formattedstring

Formatted http proxy string

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

per_pageinteger

Number of items per page for pagination

pageinteger

Page number for pagination

sort_bystring

Key for sorting or random.

Response

Successfully generated proxy list.

datastring[]

List of proxies.

messagestring

Success message.

Example response

{
  "data": [
    "socks5://user:password@17.253.94.0:8080"
  ],
  "message": "Proxy list successfully generated."
}