Introduction to PXYEDGE Documentation

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.

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 username/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://username: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.

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.

username-zone-session-random123
username-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"]
  }
}

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.

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.

POST /v1/session/release
{
  "session": "session001"
}

create auth account / whitelist ip

Create proxy authentication credentials or maintain whitelist entries through API.

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.

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.

GET /v1/proxy/list?country=US&protocol=http