Pxyedge PXYEDGE

 

Home / Documentation / Introduction

Introduction to PXYEDGE Documentation

Welcome to the official PXYEDGE documentation center. Here you will find configuration guides, tutorials, and technical reference to help you set up, configure, and maximize the performance of our premium proxy services.

What are Proxies?
Premium proxies act as intermediary servers that route your internet traffic through a global network of IP addresses, providing access, anonymity, and geo-unrestricted web access for business and professional use cases.

Available Proxy Services

  • Rotating Residential Proxies - real residential IPs with automatic rotation.

Documentation Structure

Getting Started

How to set up, configure and test proxies.

Configuration

Tutorials for location targeting, sessions and whitelist options.

API Integration

Endpoint references and automation examples.

Support

Troubleshooting and frequently asked questions.

Home / Documentation / Free Trial

Free Trial

If you register an account with Pxyedge on behalf of a company, you may be eligible for a free trial period and can receive trial traffic for connection testing and evaluation.

  • Free trial access is available after registration and account verification.
  • Trial traffic is intended for testing configuration, latency and proxy quality.
  • Production or high-volume workloads should use a paid plan.

Platforms and Conditions

Trial bandwidth and available regions may vary depending on account type, verification status and current availability.

Home / Documentation / Getting Started

Getting Started with PXYEDGE Proxies

Making a request through a residential proxy from a customer dashboard is simple. Follow this quick-start process to configure authentication and test your first request.

  1. Create a PXYEDGE account and obtain your proxy credentials.
  2. Configure youraccount/password authentication or whitelist your server IP.
  3. Select a country, state or city when your task requires location targeting.
  4. Send a test request through the gateway and check the returned IP.
curl -x http://youraccount:password@gateway.pxyedge.io:8000 https://api.ipify.org

Rotating Residential Proxies

This section explains how to make requests, configure location targeting, control sessions and whitelist IPs when using rotating residential proxies.

Making Requests

Residential proxies can be used through standard HTTP clients, browsers, scraping frameworks and automation tools. They appear as real users and help reduce blocks during automated collection.

Basic query

Build a request with authentication and optional location parameters.

Parameter Description
youraccount Proxy account youraccount
zone Name for IP pool
region Country/region, random region without this parameter
st The state you want to specify
city The city you want to specify
session Session string for sticky IPs

Country

Adding a region flag to the authorization header enables country-level targeting. If the local IP pool is unavailable, traffic may be routed through a nearby available region.

region-us
region-br
region-in
region-gb
region-ca
region-au

For example, a proxy in Brazil can be requested with region-br.

State

State targeting is useful when you need a more precise area within a country.

region-us-st-ca
region-us-st-ny
region-us-st-tx

For example, targeting California can use region-us-st-ca.

Session Control

By default, generated sessions are valid for a period of time and support multiple requests. Reusing the same session helps keep one IP during multi-step automation.

youraccount-zone-session-random123
youraccount-zone-session-random123-sesstime-10

The same session value can be reused until the session expires or is actively released.

Whitelisting IPs

IP whitelisting allows you to access the residential proxy pool simply by connecting from an authorized IP. You can configure whitelist access in the dashboard.

  1. Access the dashboard and open Account Settings.
  2. Add the IP address of your proxy client or server.
  3. Wait for synchronization and then test the proxy request.
{
  "code": 0,
  "data": {
    "whitelist": ["203.0.113.10"]
  }
}
Click the Test Proxy

test-help-documentation

Test Example 1:

Test Command :

curl -x socks5://youraccount-zone-custom:yourpassword@128.14.209.70:3000 https://ipinfo.io

(no location is specified, an IP will be assigned randomly.)

Basic CMD Format：youraccount-zone-custom:yourpassword

  • youraccount – The youraccount of the sub-account
  • yourpassword – The password of the sub-account

Test URL – @128.14.209.70:3000 https://ipinfo.io

Test Example 2:

Specify Country, Region, and Session

If you want to specify a country, region, and session, the following parameters will be appended to the basic CMD format:

-region-country-st-region-session-yoursession-sessTime-minutes

Example command 1:

curl -x socks5://youraccount-zone-custom-region-country:yourpassword@128.14.209.70:3000 https://ipinfo.io

Example command 2:

curl -x socks5://youraccount-zone-custom-session-yoursession-sessTime-minutes:yourpassword@128.14.209.70:3000 https://ipinfo.io

Example command 3:

curl -x socks5://youraccount-zone-custom-region-country-st-region-session-yoursession-sessTime-minutes:yourpassword@128.14.209.70:3000 https://ipinfo.io

Parameter description:

  • "country" : Specify country which you want to use
  • "region" : Specify region which you want to use
  • "yoursession" : the session you set
  • "sessTime" : Session Time you set

For Example

youraccount: David        Password: David1

Specify Country: Afghanistan(AF)        Specify Region: Balkh(BAL)

Session: david0              Session Time: 5

Then the cmd will be generated :

curl -x socks5://David-zone-custom-region-AF-st-BAL-session-david0-sessTime-5:David1@128.14.209.70:3000 https://ipinfo.io

(Select a "AF" IP and keep the session active for 5 minutes. By default, if the client disconnects, the IP will automatically change.)

(Some regions may currently have fewer active IPs online.
It is recommended to remove -st-region or try connecting to a different region.)

Api Document

Use the API to query traffic usage, manage sessions, create authentication credentials and retrieve proxy endpoint information.

User data usage query

Query account traffic usage through API for reporting or billing integration.

Parameter Required Type Description
account Yes String Login account
password Yes String Login password
timezone No String Format: UTC+08:00, UTC+09:30 
GET /v1/user/usage?account=demo&timezone=UTC
{
  "code": 200,
  "data": {
    "total": 100000,
    "used": 23680,
    "remain": 76320
  }
}

Dissociate the client SESSION

Release a session to force a fresh IP allocation on the next request.

Parameter Required Type Description
account Yes String Login account
password Yes String Login password
session Yes String Defines a string consisting only of letters and numbers, with a length ranging from 7 to 24 characters. 
POST /v1/session/release
{
  "session": "session001"
}

create auth account / whitelist ip

Create proxy authentication credentials or maintain whitelist entries through API.

Parameter Required Type Description
account Yes String Login account
password Yes String Login password
ip No String Whitelisted IP
type No String auth password or whitelist mode 
POST /v1/auth/create
{
  "account": "demo",
  "ip": "203.0.113.10"
}

Get IP/client information

Query IP and client information for the current proxy account or whitelist entry.

Parameter Required Type Description
account Yes String Login account
password No String Login password
email No String Email registered by account ID 
GET /v1/client/info?account=demo
{
  "code": 200,
  "data": {
    "clientIp": "198.51.100.21",
    "region": "US"
  }
}

Get proxy IP port

Retrieve proxy endpoint information for your current product package.

Parameter Required Type Description
account Yes String Login account
password Yes String Login password
period Yes Int Quantity
protocol No String http or socks5 
GET /v1/proxy/list?country=US&protocol=http