Reseller API

The Reseller API lets partners price, buy, extend and monitor NyxonProxies plans for their own customers from code. Every plan is charged to your reseller balance at your partner rate, and everything your customers see is white-label: hosts, plans and errors carry no other provider's name.

Get access#

1. Apply on the reseller program page. Tell us what you sell and roughly how much.
2. We reply by email, Telegram or Discord, agree your pricing and open your partner account.
3. Sign in to the reseller portal, top up the reseller balance in crypto and create an API key.

The portal also lets you buy and manage plans by hand and see every transaction. The full API reference, with code samples in cURL, Python and Node.js and example responses, is open to everyone, so you can read it before you apply.

Base URL#

https://nyxonproxies.com/api/v1

The machine-readable OpenAPI specification describes every endpoint, parameter and response. Import it into Postman, Insomnia or a code generator.

Authentication#

Create a key on the API keys page of the portal and send it with every request:

Authorization: Bearer nyx_live_...

Keys start with nyx_live_ and act for your reseller account only.

Responses#

Every response, success or error, uses the same envelope:

{"success": true, "data": {"balance_cents": 24209, "currency": "USD"}}
{"success": false, "error": {"code": "INSUFFICIENT_BALANCE", "message": "This plan costs $4.00; your balance is $1.20."}}

Branch on error.code. The message is meant for people. Amounts are integers in US cents (fields ending in _cents), and times are ISO 8601 in UTC.

Endpoints#

Price and buy a plan#

POST /plans/check-price takes the same body as POST /plans and returns exactly what the purchase would cost:

curl https://nyxonproxies.com/api/v1/plans/check-price \
  -H "Authorization: Bearer $NYX_KEY" \
  -H "Content-Type: application/json" \
  -d '{"product": "residential", "bandwidth_gb": 4}'

Then create the plan. The price is charged to your balance and the response holds the plan with its credentials:

curl https://nyxonproxies.com/api/v1/plans \
  -H "Authorization: Bearer $NYX_KEY" \
  -H "Content-Type: application/json" \
  -H "X-Idempotency-Key: order-10042" \
  -d '{"product": "residential", "bandwidth_gb": 4, "end_user_reference": "cust-42"}'

{
  "success": true,
  "data": {
    "plan_id": "3f2c9a1e-7b4d-4c1a-9e2f-5d8b6a0c1e47",
    "product": "residential",
    "status": "active",
    "end_user_reference": "cust-42",
    "proxy_username": "u3b180e0",
    "proxy_password": "p950ea5c",
    "connection": {
      "hostname": "geo.gw.nyxon.sh",
      "port_http": 8080,
      "port_socks": 1080,
      "format": "u3b180e0:[email protected]:8080"
    },
    "limits": {"max_gb": 4, "max_bytes": 4000000000, "bytes_used": 1288490188},
    "expires_at": "2027-10-09T12:00:00Z",
    "created_at": "2026-10-09T12:00:00Z",
    "cost_cents": 400
  }
}

Hand the username, password and connection to your customer. They use them exactly as described in these docs, with the same username parameters for targeting and sessions.

Request body#

The allowed values for each product, such as the durations and speeds, are in its config in GET /products.

Idempotency#

POST /plans and POST /plans/{plan_id}/extend accept an X-Idempotency-Key header of 8 to 64 letters, digits, - or _. Retrying with the same key returns the original response and never charges twice. Reusing a key with a different body is refused with IDEMPOTENCY_KEY_CONFLICT. Use one key per purchase, such as your order id.

Rate limits#

Limits apply per client IP:

Other read endpoints are not limited, but poll a plan at most once a minute: usage updates every one to four minutes. Over a limit you get 429 RATE_LIMITED.

Error codes#

Tips#

• Always send end_user_reference, so you can find every plan of a customer with GET /plans.
• Call check-price before showing a price to your customer, because prices can change.
• Retry 5xx and 429 answers with the same idempotency key, and never without one.