Public API v1 documentation

Authentication

Create an API key in your profile and send it in the X-API-Key header with each request.

http

X-API-Key: YOUR_API_KEY

The complete key is shown once after creation, so save it before closing the window.

POST/v1/rotation-links

Create rotation links

Create links that change the IP for Sticky or Hard proxy sessions. You can send up to 100 proxies in one request, and the API will return a result for each one.

http

POST /rotation-links
Content-Type: application/json
X-API-Key: YOUR_API_KEY

Request

Send the product code, proxy username, and the complete password generated in your proxy dashboard.

Field	Type	Description
`proxies`	array	Between 1 and 100 proxies.
`product`	string	`rp`, `pr`, `dcp`, or `mp`.
`username`	string	Proxy username shown in your dashboard.
`password`	string	Complete generated password containing a Sticky or Hard session.

Product codes:

rp — Residential
pr — Residential Pro
dcp — Datacenter
mp — Mobile

json

{
  "proxies": [
    {
      "product": "rp",
      "username": "u42_abcd",
      "password": "Px7mQ2_country-US_session-afk1rlnGs3"
    },
    {
      "product": "mp",
      "username": "u42_mobile",
      "password": "Mx9Qa1_country-DE"
    }
  ]
}

Response

The API returns a change-IP link for every accepted proxy. If one proxy needs attention, the remaining proxies are still processed.

json

{
  "success": true,
  "data": {
    "results": [
      {
        "index": 0,
        "status": "created",
        "product": "rp",
        "rotationUrl": "https://public-api.proxxxymiron.com/r/aN7k2Vf4Lx9cQp8mZ1sT6_u",
        "expiresAt": "2027-07-21T12:00:00.000Z"
      },
      {
        "index": 1,
        "status": "rejected",
        "product": "mp",
        "error": {
          "code": "SESSION_REQUIRED",
          "message": "The proxy password must contain one sticky session"
        }
      }
    ],
    "summary": {
      "requested": 2,
      "created": 1,
      "rejected": 1
    }
  }
}

Each result keeps the same index as the proxy in your request.

Errors

Errors for an individual proxy appear inside its result:

Code	What to check
`INVALID_CREDENTIALS`	Confirm that the username and password belong to an active proxy plan.
`SESSION_REQUIRED`	Generate the proxy again using a Sticky or Hard session.

If the whole request cannot be accepted, the API returns one error:

json

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Request validation failed"
  }
}

Common request errors:

HTTP status	Code	Meaning
`400`	`INVALID_REQUEST`	The request body or one of its fields is invalid.
`401`	`UNAUTHORIZED`	The API key is missing, invalid, or expired.
`403`	`FORBIDDEN`	The key does not have access to this endpoint.
`413`	`PAYLOAD_TOO_LARGE`	The request is too large.
`429`	`RATE_LIMIT_EXCEEDED`	Too many requests were sent in a short period.
`500`	`INTERNAL_ERROR`	The request could not be completed. Try again later.
`503`	`SERVICE_UNAVAILABLE`	The service is temporarily unavailable.

GET/r/{rotation-link}

Use a rotation link

Open the returned URL with a GET request whenever you want to change the IP for that proxy session.

http

GET https://public-api.proxxxymiron.com/r/aN7k2Vf4Lx9cQp8mZ1sT6_u

No API key is needed when using a rotation link. Keep the link private: anyone who has it can request an IP change until it expires.

Proxxxymiron Public API

Authentication

Create rotation links

Request

Response

Errors

Use a rotation link