Skip to main content
GET
Search Proxies

Authorizations

X-API-Private-Key
string
header
required

Private API key for user-level authentication.

X-API-Public-Key
string
header
required

Public API key for user-level authentication.

Query Parameters

proxy_id
integer<string>

ID of the proxy

service_id
string

Service ID associated with the proxy

proxy_ip_address
string

Main IP Address of the proxy

subnet_id
string

Main subnet of the proxy

subnet_id_v6
string

Main subnet of the proxy

ip_address_id_v4
string

IPv4 address ID of the proxy

ip_address_id_v6
string

IPv6 address ID of the proxy

proxy_http_port
integer

http port of the proxy

proxy_socks5_port
integer

socks5 port of the proxy

proxy_status
enum<string>

Current status of the proxy

Available options:
available,
in_use,
reserved,
waiting,
pending_deletion
proxy_type
enum<string>

Type of the proxies you want returned in the search

Available options:
isp,
datacenter,
residential,
mobile
proxy_protocol
enum<string>

Version of the proxies you want returned in the search

Available options:
ipv4,
ipv6,
dual
country_id
string

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

country_name
string

Name of the country the proxy is located in

subdivision_id
string

ISO Country Code (ISO 3166-2)

subdivision_name
string

Name of the subdivision the proxy is located in

city_id
integer

ID of the city the proxy is located in

city_name
string

Name of the city the proxy is located in

city_timezone
string

Timezone of the City the proxy is located in

city_example_postcode
string

Example postcode of the City the proxy is located in

city_latitude
string

Latitude of the City the proxy is located in

city_longitude
string

Longitude of the City the proxy is located in

asn_id
string

Unique identifier of the ASN of the proxy

asn_name
string

Name associated with the ASN of the proxy

proxy_last_update_datetime
string<date-time>

Datetime the proxy was last updated

proxy_user_id
string

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

per_page
integer

Number of items per page for pagination

page
integer

Page number for pagination

sort_by
string

Key for sorting or random.

Response

200 - application/json

Successful Proxy search

Proxy search was successful.

data
object[]

Array of Proxy items matching the search criteria up to the limit of per_page paramater.

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.