SigmaProxies

Retrieve the balance for a user

HTTP Method: GET

Endpoint URL: /api/user/getBalance

Parameters
  • API (String): Generated API key (as a query parameter).
Example Request
      
        GET /api/user/getBalance?API=123
Example Response
      
        {
          "status": 200,
          "message": "Success",
          "data": {
            "balance": 100
          }
        }

Purchase a proxy package for a user.

HTTP Method: POST

Endpoint URL: /api/user/buyProxy?API=123

Parameters
  • API (String): Generated API key (as a query parameter).
  • network (String): Network type of the proxy (residentialPremium, Residential, Mobile, or Datacenter).
  • value (Numeric): Value of the package to purchase. (Can be a string in mobile plans [1 Day] | [3 Days] | [1 Week] | [1 Month] |)
  • ports (Numeric, optional): Number of ports for Mobile network (required only for Mobile network).
  • whitelist (String, optional): Whitelist IP address for Mobile network (required only for Mobile network).
Example Request
        
          POST /api/user/buyProxy?API=123

          {
            "network": "Residential",
            "value": 1
          }
Example Request 2
        
          POST /api/user/buyProxy?API=123

          {
            "network": "Mobile",
            "ports": "1",
            "value": "1 Week",
            "whitelist":"192.168.0.1"
          }
Example Response
        
          {
            "status": 200,
            "message": "Order created!",
            "code": "ABC123"
          }

Extend the validity of a proxy package for a user.

HTTP Method: POST

Endpoint URL: /api/user/extendProxy?API=123

Parameters
  • API (String): Generated API key (as a query parameter).
  • network (String): Network type of the proxy (residentialPremium or Residential or Datacenter).
  • value (Numeric): Value to extend the package (e.g., duration in months or additional bandwidth).
  • id (String): Package ID to extend.
Example Request
        
          POST /api/user/extendProxy?API=123

          {
            "network": "Residential",
            "value": 1,
            "id": "ABC123"
          }
Example Response
        
          {
            "status": 200,
            "message": "Package extended!",
            "code": "ABC123"
          }

Retrieve Order Details

HTTP Method: POST

Endpoint URL: /api/orders/orderDetails?API=123

Parameters
  • API (String): Generated API key (as a query parameter).
  • id (String): Package ID to retrieve details for.
Request Body

The request body should be empty.

Example Request
        
          POST /api/orders/orderDetails?API=123

          {
            "id": "ABC123"
          }
Example Response
        
          {
            "status": 200,
            "data": {
              "type": "Residential",
              "expiry": "2023-06-30",
              "info": {
                "total": 100,
                "remaining": 50,
                "access": {
                  "host": "resi.sigmaproxies.com",
                  "port": "8080",
                  "username": "your_username",
                  "password": "your_password"
                }
              }
            }
          }

Whitelist Mobile IP

HTTP Method: POST

Endpoint URL: /api/user/Whitelist?API=123

Parameters
  • API (String): Generated API key (as a query parameter).
Request Body
  • id (String): Package ID to whitelist IP for.
  • ip (String): IP address to whitelist.
Example Request
        
          POST /api/user/Whitelist?API=123

          {
            "id": "ABC123",
            "ip": "192.168.0.1"
          }
Example Response
        
          {
            "status": 200,
            "message": "Whitelist successful!"
          }

If the IP is still locked, the response will be:

        
          {
            "status": 400,
            "message": "IP locked till 2023-06-30 18:00:00"
          }