NyanProxy Developer API
Integrate high-speed residential proxy provisioning directly into your scrapers, applications, and bot pipelines. Exclusively available to accounts with the Lifetime Reseller Plan.
Base URL
Authentication
Authorization header:np_live_ and can be revealed, copied, or instantly regenerated at any time.
Zero Rate-Limits / DDoS Policy
Requests authorized with a valid np_live_ Reseller API Key are completely exempted from automated anti-DDoS burst limits and connection throttling. You can freely generate tens of thousands of proxies and fire high-concurrency provisioning scripts without IP ban risks.
1. User Profile & Telemetry
Returns authenticated user details, spendable balance, wholesale rate per GB, total bandwidth consumed across all plans, cumulative spend, and count of active plans.
2. List User Plans
Lists all residential proxy plans belonging to your account. Each plan includes its random 6-digit plan_id (e.g. 627121), custom name, proxy password, allocated GB, used GB, and remaining quota.
3. Buy Proxy Plan
Instantly provisions a new residential proxy plan and deducts the wholesale cost ($0.10 per 1 GB) from your account balance.
JSON Request Body
| Field | Type | Status | Description |
|---|---|---|---|
| gigabytes | number | required | Bandwidth in GB to purchase (minimum 1 GB). Also accepts amount_gb. |
| name | string | optional | Friendly custom label for the plan (e.g. "Customer #49 Sub-account"). |
4. Top Up Plan Bandwidth
Adds residential bandwidth to an existing plan at wholesale reseller pricing ($0.10/GB), automatically reactivating the plan if it was depleted.
JSON Request Body
| Field | Type | Status | Description |
|---|---|---|---|
| plan_id | string | number | required | Your 6-digit random plan ID (e.g. "627121" or 627121). |
| gigabytes | number | required | Additional GB to add to the plan (minimum 1 GB). |
5. Generate Proxies (No Limits)
Generates ready-to-use proxy endpoint strings with no upper quantity limit. Supports 220+ countries, rotating or sticky sessions, and customizable output formats.
JSON Request Body
| Field | Type | Status | Description |
|---|---|---|---|
| plan_id | string | number | required | The 6-digit plan identifier (e.g. "627121"). |
| country | string | optional | 2-letter ISO country code (e.g. "us", "gb", "de", "jp") or "all". Default is "all". |
| protocol | string | optional | Proxy protocol to generate: "http" or "socks5" (Port 58996). NyanProxy's high-speed gateway features dual-stack multiplexing, supporting both HTTP CONNECT and SOCKS5 on port 58996. |
| session_type | string | optional | "rotating" (new IP on each request) or "sticky" (persists session IP). Default is "rotating". |
| count | number | optional | Number of proxy lines to generate (No Limit: 10, 500, 5000+). Default is 10. |
| format | string | optional |
"user:pass@host:port" (default),"host:port:user:pass","host:port@user:pass", or"url" (e.g. socks5://user:pass@host:58997).
|
| prefix | string | optional | Optional custom identifier prefix for sticky session tracking. |
Interactive Code Examples
Error Codes
| Status | Description |
|---|---|
| 200 OK | Request succeeded. Data returned in response body. |
| 400 Bad Request | Missing parameters or insufficient balance to complete order. |
| 401 Unauthorized | Missing or invalid np_live_ API key. |
| 403 Forbidden | Account suspended or user has not yet unlocked the Lifetime Reseller Plan ($100 deposits). |
| 404 Not Found | Target plan ID was not found in your account. |
| 500 Internal Error | Unexpected server error. |