Skip to main content
POST
/
public
/
user
/
proxy
/
list_by_id
Generate Proxy List By ID
curl --request POST \
  --url https://api.byteful.com/1.0/public/user/proxy/list_by_id \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Private-Key: <api-key>' \
  --header 'X-API-Public-Key: <api-key>' \
  --data '
{
  "list_authentication": "username_and_password",
  "list_format": "standard",
  "list_protocol": "http",
  "list_version": "ipv4",
  "proxy_ids": [
    "19efadd4-5814-4986-90be-4460e7d05c29",
    "1847e66a-a56e-4bc9-94e2-88a8cf3d0ad3"
  ],
  "proxy_user_id": "some_proxy_user_id"
}
'
{
  "data": [
    "socks5://user:[email protected]: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.

Headers

​
Content-Type
string
default:application/json
required

Content type for the request body as application/json.

Body

application/json
​
list_authentication
enum<string>
default:username_and_password

Authentication type for the proxies in the returned list.

Available options:
username_and_password,
ip_address,
proxy_specific
Example:

"username_and_password"

​
list_format
enum<string>
default:standard

Desired format for displaying the proxies in the returned list.

Available options:
standard,
http,
socks5,
socks5h
Example:

"standard"

​
list_protocol
enum<string>
default:http

Desired protocol for the proxies in the returned list.

Available options:
http,
socks5
Example:

"http"

​
list_version
enum<string>
default:ipv4

IP version preference.

Available options:
ipv4,
ipv6
Example:

"ipv4"

​
proxy_ids
string[]

List of proxy UUIDs to retrieve.

Example:
[
  "19efadd4-5814-4986-90be-4460e7d05c29",
  "1847e66a-a56e-4bc9-94e2-88a8cf3d0ad3"
]
​
proxy_user_id
string

ID of the proxy_user used for authentication with the proxies.

Example:

"some_proxy_user_id"

Response

200 - application/json

Successfully generated proxy list.

​
data
string[]

The resulting list of proxies in the requested format.

Example:
["socks5://user:[email protected]:8080"]
​
message
string

Success message.

Example:

"Proxy list successfully generated."