Local API V2 – Proxy Interface

List Proxies

Endpoint

GET /openapi/v2/proxies

Returns a list of proxies.

Query Parameters

Name	Type	Required	Description
page	integer	No	Page number for page-based pagination, starting from 1.
page_size	integer	No	Number of items per page for page-based pagination.
cursor	string	No	Cursor for cursor-based pagination.
limit	integer	No	Number of items per page for cursor-based pagination.
serial_no	integer	No	Proxy serial number.
id	string	No	Proxy ID.
type	string	No	Proxy type.
host	string	No	Proxy host.
remark	string	No	Remark.
proxy_group_id	string	No	Proxy group ID.

data.list in the response contains the Proxy list items. See Proxy Response Fields for field details.

Create a Proxy

Endpoint

POST /openapi/v2/proxies

Creates a Proxy.

Request Parameters

The request body uses the Proxy create or update parameters described in Proxy Parameters.

Request Example

{
  "type": "http",
  "host": "127.0.0.1",
  "port": 8080,
  "user": "",
  "password": "",
  "ipchecker": "ipapi",
  "ip_version": "ipv4",
  "remark": "proxy created by Local API V2"
}

Get Proxy Details

Endpoint

GET /openapi/v2/proxies/{proxyId}

Path Parameters

Name	Type	Required	Description
proxyId	string	Yes	Proxy ID.

Update a Proxy

Endpoint

PATCH /openapi/v2/proxies/{proxyId}

Path Parameters

Name	Type	Required	Description
proxyId	string	Yes	Proxy ID.

Request Parameters

The request body uses the Proxy create or update parameters described in Proxy Parameters.

Delete a Proxy

Endpoint

DELETE /openapi/v2/proxies/{proxyId}

Path Parameters

Name	Type	Required	Description
proxyId	string	Yes	Proxy ID.

Check a Saved Proxy

Endpoint

POST /openapi/v2/proxies/{proxyId}/check

Checks a saved Proxy.

Path Parameters

Name	Type	Required	Description
proxyId	string	Yes	Proxy ID.

Check a Temporary Proxy

Endpoint

POST /openapi/v2/proxies/check

Checks an unsaved temporary Proxy.

Request Parameters

The request body uses the Proxy check parameters described in Proxy Check Parameters.

Response Example

{
  "code": 0,
  "msg": "success",
  "data": {
    "ok": true,
    "out_ip": "1.2.3.4",
    "country": "United States",
    "country_code": "US",
    "region": "California",
    "city": "Los Angeles",
    "timezone": "America/Los_Angeles",
    "status": "success",
    "error_message": ""
  },
  "next": null
}

The allowed values for data.status are wait, success, and fail.

Parameter Reference

Proxy Parameters

ProxyUpsertRequest is used to create and update proxies.

Name	Type	Required	Description
type	string	No	Proxy type. Allowed values: none, http, https, ssh, socks5.
host	string	No	Proxy host.
port	integer	No	Proxy port.
user	string	No	Proxy username.
password	string	No	Proxy password.
ipchecker	string	No	IP check provider. Allowed values: ip2location, ipapi.
ip_version	string	No	IP address type. Allowed values: ipv4, ipv6.
remark	string	No	Remark.
proxy_group_id	string	No	Proxy group ID.

Proxy Check Parameters

ProxyCheckRequest is used to check a temporary Proxy.

Name	Type	Required	Description
type	string	No	Proxy type. Allowed values: none, http, https, ssh, socks5.
host	string	No	Proxy host.
port	integer	No	Proxy port.
user	string	No	Proxy username.
password	string	No	Proxy password.
ipchecker	string	No	IP check provider. Allowed values: ip2location, ipapi.
ip_version	string	No	IP address type. Allowed values: ipv4, ipv6.
timeout_ms	integer	No	Timeout in milliseconds.

Proxy Response Fields

Name	Type	Description
proxy_id	string	Proxy ID.
serial_no	integer	Proxy serial number.
type	string	Proxy type. Allowed values: none, http, https, ssh, socks5.
host	string	Proxy host.
port	integer	Proxy port.
user	string	Proxy username.
password	string	Proxy password.
ipchecker	string	IP check provider. Allowed values: ip2location, ipapi.
ip_version	string	IP address type. Allowed values: ipv4, ipv6.
proxy_group_id	string	Proxy group ID.
remark	string	Remark.