Skip to main content

​
Installation

1

Install via npm

npm i clearproxy -g
2

Set API Key

clearproxy set-key <your_api_key>
3

Verify Installation

clearproxy me

​
Quick Start

# Set API key
clearproxy set-key clearpx_blablabla6767

# Check account info
clearproxy me

# Check proxies from file
clearproxy check proxies.txt

​
Commands

​
set-key

Save your ClearProxy.io API key locally for use in all subsequent requests. 
clearproxy set-key <apiKey>
​
apiKey
string
required
Your ClearProxy.io API key from the dashboard

​
check

Main command for checking proxy lists. Supports input from file, stdin, or inline arguments. 
clearproxy check [input] [options]

​
Parameters

​
input
string
Path to proxy file or inline proxies (optional)
​
--region
string
Region to use for checking (us1, us2, sg1, jp1, etc.)
​
--timeout
number
default:"4000"
Request timeout per proxy in milliseconds (1000-30000)
​
--type
string
default:"http"
Proxy type: http, socks4, or socks5
​
--out
string
default:"result.json"
Output file path
​
--format
string
default:"json"
Output format: json, txt, or yaml
​
--simple
boolean
default:"false"
Simplified output (only ip:port or user:pass@ip:port)

​
Supported Proxy Formats

FormatExample
Standard1.1.1.1:8080
With Authuser:pass@1.1.1.1:8080
Colon Format1.1.1.1:8080:user:pass

​
Examples

# Check from file
clearproxy check proxies.txt
Output Details:
  • Working/Failed proxy count
  • Response time & anonymity level
  • Country & ISP information
  • Checks used & remaining quota
  • Processing time
—

​
me

Display account information and remaining quota. 
clearproxy me [options]
​
--debug
boolean
default:"false"
Show raw JSON response from API
​
--history
boolean
default:"false"
Display last 10 proxy checks
​
--usage
boolean
default:"false"
Show usage chart for last 30 days
Output includes:
  • User ID and email
  • Remaining checks quota
  • Recent check history (with —history)
  • Usage statistics for last 30 days (with —usage)

​
regions

List all available regions for proxy checking. 
clearproxy regions [options]
​
--json
boolean
default:"false"
Output in JSON format
Each region represents a different geographical location where your proxies will be tested from.

​
health

Check the health and availability of ClearProxy API. 
clearproxy health
Returns status, version, uptime and active regions information.

​
Version

Current version: 1.0.0 Use clearproxy --version or clearproxy -v to check your installed version.