GET
/
public
/
user
/
proxy
/
list_by_search
curl --request GET \
  --url https://api.pingproxies.com/1.0/public/user/proxy/list_by_search \
  --header 'X-API-Private-Key: <api-key>' \
  --header 'X-API-Public-Key: <api-key>'
{
  "data": [
    "socks5://user:password@17.253.94.0:8080"
  ],
  "message": "Proxy list successfully generated."
}

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

​
list_protocol
enum<string>
default:http

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

Available options:
http,
socks5
​
list_version
enum<string>
default:ipv4

IP version preference.

Available options:
ipv4,
ipv6
​
list_format
enum<string>
default:standard

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

Available options:
standard,
http,
socks5,
socks5h
​
proxy_user_id
string

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

​
list_authentication
enum<string>
default:username_and_password

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

Available options:
username_and_password,
ip_address,
proxy_specific
​
proxy_id
integer

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

​
http_formatted
string

Formatted http proxy string

​
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
​
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

Datetime the proxy was last updated

​
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
Successfully generated proxy list.
​
data
string[]

List of proxies.

Example:
["socks5://user:password@17.253.94.0:8080"]
​
message
string

Success message.

Example:

"Proxy list successfully generated."