# 🤖 Agent Cheat Sheet

This page compresses everything you need to connect to EProxies onto one screen, for AI agents and developers who want fast lookups. Every example runs as-is once you substitute your credentials.

## Endpoints

```
Proxy gateway:   proxy.eproxies.net:23333   (one port for HTTP / HTTPS / SOCKS5)
Dashboard:       https://dashboard.eproxies.io
API extraction:  https://api.eproxies.net/gateway_api/extract_ip   (whitelist mode)
Country list:    https://api.eproxies.net/gateway_api/country-list
```

Machine-readable API definition: [OpenAPI specification](https://www.eproxies.io/docs/openapi.json)

## Username syntax (credential mode)

```
{account}-pool-flow[-region-{country code}][-state-{state}][-city-{city}][-asn-{ASN}][-sid-{8-char random}-ttl-{minutes}]
```

Rules:

* Segment order is fixed; concatenate left to right as shown. The password never changes.
* `region`: ISO 3166-1 two-letter country code, e.g. `US`, `GB`, `JP`.
* `state`: full state/province name, e.g. `California`; `city`: city name in lowercase with spaces removed, e.g. `losangeles`. **`city` requires `state`.**
* `asn`: format `AS15802`; **mutually exclusive with state / city** (combine with region only).
* `sid` + `ttl`: sticky session. `sid` is an 8-character random alphanumeric string (generate it yourself; a new sid means a new IP); `ttl` is the hold time in minutes, range **1–120**. Without `sid`, the IP rotates on every request.

Examples (simple to complex):

```
USERNAME-pool-flow                                                    # Global random, rotate per request
USERNAME-pool-flow-region-US                                          # US IP
USERNAME-pool-flow-region-US-state-California                         # California, US
USERNAME-pool-flow-region-US-state-California-city-losangeles         # Los Angeles, California, US
USERNAME-pool-flow-region-AE-asn-AS15802                              # UAE, specific ASN
USERNAME-pool-flow-region-US-sid-a1b2c3d4-ttl-30                      # US IP, held for 30 minutes
```

## Minimal working examples

```bash
# HTTP proxy
curl -x proxy.eproxies.net:23333 -U "USERNAME-pool-flow-region-US:PASSWORD" https://ipinfo.io

# SOCKS5 proxy (same port)
curl -x socks5://USERNAME-pool-flow-region-US:PASSWORD@proxy.eproxies.net:23333 https://ipinfo.io
```

```python
import requests

proxy_url = "http://USERNAME-pool-flow-region-US:PASSWORD@proxy.eproxies.net:23333"
proxies = {"http": proxy_url, "https": proxy_url}
print(requests.get("https://ipinfo.io", proxies=proxies, timeout=30).json())
```

```javascript
const { HttpsProxyAgent } = require("https-proxy-agent");
const axios = require("axios");

const agent = new HttpsProxyAgent(
  "http://USERNAME-pool-flow-region-US:PASSWORD@proxy.eproxies.net:23333"
);
axios.get("https://ipinfo.io", { httpsAgent: agent }).then((r) => console.log(r.data));
```

## Whitelist mode (no-credential extraction)

Once your exit IP is whitelisted, GET a list of `IP:port` proxies and connect directly — no credentials. The whitelist itself can also be managed via API:

```bash
# Extract: count is required; country=country code/Global; protocol=http|socks5; format=txt|json;
#          session=sticky|random; separator=crlf|br|cr|lf|tab (or st=custom separator)
curl "https://api.eproxies.net/gateway_api/extract_ip?count=10&country=US&protocol=http&format=json&session=sticky"

# Whitelist management (userKeyValue = user key, available in the dashboard)
curl "https://api.eproxies.net/gateway_api/add-ip?userName=USERNAME&userKeyValue=USER_KEY&ipAddress=203.0.113.10"
curl "https://api.eproxies.net/gateway_api/del-ip?userName=USERNAME&userKeyValue=USER_KEY&ipAddress=203.0.113.10"
curl "https://api.eproxies.net/gateway_api/lists-ip?userName=USERNAME&userKeyValue=USER_KEY"

# Supported country list
curl "https://api.eproxies.net/gateway_api/country-list"
```

See [API Extraction](https://www.eproxies.io/docs/usage/api-extraction) for details.

## Key facts

* Credentials activate immediately after purchase; when traffic runs out, top up and **keep the same credentials with zero downtime**.
* Unused traffic remains available for the rest of the plan's validity period.
* To switch IPs mid-session in sticky mode: change the `sid`.
* City-level targeting costs nothing extra.
* The service is available only outside mainland China.
* Support: [Telegram](https://t.me/eproxies) / [Discord](https://discord.gg/yzZNxN75) (24/7), email `support@eproxies.io`.