List proxies

GET

/api/v1/proxies

Return a paginated list of proxies accessible to the current user and team. Supports custom, api, integ, and syt modes. API proxy settings include auth_type (whitelist, the default, or credential for username/password authentication) and the corresponding username and password. password and the API extraction URL are sensitive fields and must not be written to caller logs.

Request parameters

Authorization Bearer Token

Include your API Key as a Bearer token in the Authorization request header.

Authorization: Bearer <api-key>

Query parameters

Fields

integer

Page number

Default1

Example1

minimum: 1

integer

Items per page; default: 10, maximum: 100

Default10

Example10

minimum: 1maximum: 100

string

Partial-match filter by proxy ID

minLength: 1

string

Partial-match filter by proxy name

minLength: 1

string

Partial-match filter by proxy notes

minLength: 1

string

Filter by proxy mode. custom means a custom proxy; api means a proxy obtained from an extraction URL; integ means an integrated proxy; syt means a synchronized SiYeTian Proxy.

Enum

string

Filter by proxy protocol. http means HTTP; https means HTTPS; socks5 means SOCKS5.

Enum

string

Filter by the most recent proxy check status. unchecked means no check has been performed; available means the last check succeeded; unavailable means the last check failed.

Enum

string

Filter by expiration status: true means expired; false means not expired or no expiration date. Primarily used for integ and syt proxies.

Enum

string

Sort field and direction: name means name; created_at means creation time; updated_at means update time; checked_at means most recent check time. asc means ascending; desc means descending.

Enum

Request code examples

JavaScript / TypeScript: Node.js 18+ with fetch; PHP: cURL extension; Go: 1.16+; Java: JDK 11+. Replace the token and example parameter values before running.

curl -H 'Authorization: Bearer <TOKEN>' 'http://local.zhongyibrowser.com:39025/api/v1/proxies?page=1&size=10'

fetch("http://local.zhongyibrowser.com:39025/api/v1/proxies?page=1&size=10", {
  method: "GET",
  headers: {
      "Authorization": "Bearer <TOKEN>"
    },
})
  .then((response) => response.json())
  .then((data) => console.log(data))

async function main(): Promise<void> {
  const options: RequestInit = {
    "method": "GET",
    "headers": {
      "Authorization": "Bearer <TOKEN>"
    }
  }
  const response: Response = await fetch("http://local.zhongyibrowser.com:39025/api/v1/proxies?page=1&size=10", options)
  const data: unknown = await response.json()
  console.log(data)
}

main().catch(console.error)

<?php
$ch = curl_init('http://local.zhongyibrowser.com:39025/api/v1/proxies?page=1&size=10');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <TOKEN>',
  ],
]);

$response = curl_exec($ch);
if ($response === false) {
  throw new RuntimeException(curl_error($ch));
}
curl_close($ch);
echo $response . PHP_EOL;

package main

import (
	"fmt"
	"io"
	"log"
	"net/http"
)

func main() {
	req, err := http.NewRequest("GET", "http://local.zhongyibrowser.com:39025/api/v1/proxies?page=1&size=10", nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("Authorization", "Bearer <TOKEN>")

	response, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer response.Body.Close()

	data, err := io.ReadAll(response.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
  public static void main(String[] args) throws Exception {
    HttpClient client = HttpClient.newHttpClient();
    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("http://local.zhongyibrowser.com:39025/api/v1/proxies?page=1&size=10"))
        .header("Authorization", "Bearer <TOKEN>")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();

    HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  }
}

import requests

url = "http://local.zhongyibrowser.com:39025/api/v1/proxies?page=1&size=10"
headers = {
    "Authorization": "Bearer <TOKEN>"
}

response = requests.get(url, headers=headers)
print(response.json())

Responses

Success: code = 0. Failure: code > 0. Select a status to view its fields and example. Expand objects to inspect nested fields. Optional fields may be omitted.

Proxy list

Body

application/jsonProxyListSuccessResponse

Fields

numberrequired

Business status code; always 0 on success

Enum

stringrequired

Business status message; always success on success

Enum

objectrequired

Endpoint business data

Additional fields are not allowed.

Generated from the schema; not a live response.

{
  "code": 0,
  "message": "success",
  "data": {
    "items": [
      {
        "id": "string",
        "name": "string",
        "remark": "string",
        "status": "unchecked",
        "checked_at": "2024-01-15T09:30:00Z",
        "browser_count": 0,
        "is_expired": true,
        "created_at": "2024-01-15T09:30:00Z",
        "updated_at": "2024-01-15T09:30:00Z",
        "mode": "custom",
        "config": {
          "protocol": "http",
          "ip_protocol": "ipv4",
          "host": "string",
          "port": 0,
          "username": "string",
          "password": "string"
        }
      }
    ],
    "total": 0,
    "page": 0,
    "size": 0,
    "total_pages": 0
  }
}

View all business error codes and HTTP statuses

List proxies ​

Request parameters

Request code examples

Responses

List proxies