HypeProxy.io

https://docs.hypeproxy.io
Admin
HypeProxy.io is a 4G and LTE proxy provider offering a REST API for automated proxy management, IP...
Tokens:9,126
Snippets:83
Trust Score:8.4
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example JSON order model

Source: https://docs.hypeproxy.io/api/order-process-1.md

Example JSON payload to send to either endpoint. Contains productId, locationId, billingPeriod, paymentMethod, quantity, and isAutoRenewed. The couponCode property is optional and not shown here.

```json
{
    "productId": "7d8f2363-2fc9-47af-aae2-c22043af12ed",
    "locationId": "d6e32771-4733-4de5-9b95-d0ef1b30f00c",
    "billingPeriod": "Monthly",
    "paymentMethod": "CreditCard",
    "quantity": 1,
    "isAutoRenewed": true
}
```

--------------------------------

### GET /v2/Insight/Ping/{productDetailsId}

Source: https://docs.hypeproxy.io/api/proxy-insight.md

Pings a proxy to check its availability and response time. Requires the productDetailsId of the product.

```APIDOC
## GET /v2/Insight/Ping/{productDetailsId}

### Description
Pings a proxy to check its availability and response time.

### Method
GET

### Endpoint
/v2/Insight/Ping/{productDetailsId}

### Parameters
#### Path Parameters
- **productDetailsId** (string) - Required - The identifier of the product.

### Response
#### Success Response (200)
- **status** (string) - The status of the ping (e.g., success or failure).
- **responseTime** (number) - The response time in milliseconds.

#### Response Example
{
  "status": "success",
  "responseTime": 123
}
```

--------------------------------

### GET /v2/Insight/IpThreats/{productDetailsId}

Source: https://docs.hypeproxy.io/api/proxy-insight.md

Retrieves threat information associated with the IP address of the proxy. Requires the productDetailsId of the product.

```APIDOC
## GET /v2/Insight/IpThreats/{productDetailsId}

### Description
Retrieves threat information associated with the IP address of the proxy.

### Method
GET

### Endpoint
/v2/Insight/IpThreats/{productDetailsId}

### Parameters
#### Path Parameters
- **productDetailsId** (string) - Required - The identifier of the product.

### Response
#### Success Response (200)
- **threats** (array) - List of threats associated with the IP.

#### Response Example
{
  "threats": [
    {
      "type": "malware",
      "description": "IP is associated with malware activity"
    }
  ]
}
```

--------------------------------

### GET /v2/Insight/IpDetails/{productDetailsId}

Source: https://docs.hypeproxy.io/api/proxy-insight.md

Retrieves detailed information about the IP address of the proxy. Requires the productDetailsId of the product.

```APIDOC
## GET /v2/Insight/IpDetails/{productDetailsId}

### Description
Retrieves detailed information about the IP address of the proxy.

### Method
GET

### Endpoint
/v2/Insight/IpDetails/{productDetailsId}

### Parameters
#### Path Parameters
- **productDetailsId** (string) - Required - The identifier of the product.

### Response
#### Success Response (200)
- **ip** (string) - The IP address.
- **country** (string) - The country of the IP.
- **city** (string) - The city of the IP.
- **isp** (string) - The ISP of the IP.

#### Response Example
{
  "ip": "192.168.1.1",
  "country": "United States",
  "city": "New York",
  "isp": "Example ISP"
}
```

--------------------------------

### GET /v2/Renews/{productDetailsId}

Source: https://docs.hypeproxy.io/api/ip-rotation.md

Retrieves the IP renew configuration for a specific product.

```APIDOC
## GET /v2/Renews/{productDetailsId}

### Description
Get the renew parameters for a specific product.

### Method
GET

### Endpoint
/v2/Renews/{productDetailsId}

### Parameters
#### Path Parameters
- **productDetailsId** (string) - Required - The identifier of the product details.

```

--------------------------------

### GET /v2/Insight/Ip/{productDetailsId}

Source: https://docs.hypeproxy.io/api/proxy-insight.md

Retrieves the remote IP address of the proxy. Requires the productDetailsId of the product.

```APIDOC
## GET /v2/Insight/Ip/{productDetailsId}

### Description
Retrieves the remote IP address of the proxy.

### Method
GET

### Endpoint
/v2/Insight/Ip/{productDetailsId}

### Parameters
#### Path Parameters
- **productDetailsId** (string) - Required - The identifier of the product.

### Response
#### Success Response (200)
- **ip** (string) - The remote IP address.

#### Response Example
{
  "ip": "192.168.1.1"
}
```

--------------------------------

### GET /v2/Renews/Execute/{productDetailsId}

Source: https://docs.hypeproxy.io/api/ip-rotation.md

Triggers a manual IP rotation for a specific product. The operation is asynchronous and returns a requestId.

```APIDOC
## GET /v2/Renews/Execute/{productDetailsId}

### Description
Execute a manual IP rotation. The operation is asynchronous and returns a requestId.

### Method
GET

### Endpoint
/v2/Renews/Execute/{productDetailsId}

### Parameters
#### Path Parameters
- **productDetailsId** (string) - Required - The identifier of the product details.

```

--------------------------------

### API Rate Limit Rules

Source: https://docs.hypeproxy.io/basic-concepts/api-rate-limit.md

Lists the rate limits for specific API endpoints, including the period and maximum number of requests allowed. POST endpoints are limited, while GET endpoints are generally not limited except for the two listed GET endpoints. Use this to understand which endpoints have restrictions and their limits.

```json
[
    {
        "Endpoint": "post:/v2/Authentication/SignUp",
        "Period": "1m",
        "Limit": 1
    },
    {
        "Endpoint": "post:/v2/Authentication/SignIn",
        "Period": "1m",
        "Limit": 5
    },
    {
        "Endpoint": "post:/v2/Orders/Validate",
        "Period": "1s",
        "Limit": 1
    },
    {
        "Endpoint": "post:/v2/Orders/Create",
        "Period": "15s",
        "Limit": 1
    },
    {
        "Endpoint": "post:/v2/Profile",
        "Period": "5s",
        "Limit": 1
    },
    {
        "Endpoint": "post:/v2/Tickets",
        "Period": "1m",
        "Limit": 1
    },
    {
        "Endpoint": "post:/v2/TicketAnswers/*",
        "Period": "1m",
        "Limit": 3
    },
    {
        "Endpoint": "post:/v2/Credentials/*",
        "Period": "1m",
        "Limit": 5
    },
    {
        "Endpoint": "post:/v2/Comments/*",
        "Period": "1m",
        "Limit": 5
    },
    {
        "Endpoint": "get:/v2/Renews/Execute/*",
        "Period": "30s",
        "Limit": 1
    },
    {
        "Endpoint": "get:/v2/Insight/*",
        "Period": "30s",
        "Limit": 1
    }
]
```

--------------------------------

### GET https://hypeproxy.io/api/Utils/DirectRenewIp/{id}

Source: https://docs.hypeproxy.io/api/v1-api-documentation.md

This endpoint triggers the IP renew of the related proxy as an asynchronous operation. The process takes around 8 seconds in background and requires the reboot of the USB modem.

```APIDOC
## [GET] https://hypeproxy.io/api/Utils/DirectRenewIp/{id}

### Description
This endpoint triggers the IP renew of the related proxy as an asynchronous operation. The process takes around 8 seconds in background and requires the reboot of the USB modem.

### Method
GET

### Endpoint
https://hypeproxy.io/api/Utils/DirectRenewIp/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Proxy ID, here to know how to get this ID.

### Response
#### Success Response (200)
- **body** (string) - "IP Renew done."

#### Response Example
"IP Renew done."
```

--------------------------------

### Order Validation API responses (200 OK, 400 Bad Request)

Source: https://docs.hypeproxy.io/api/order-process-1/order-validation.md

Response examples for the POST /v2/Orders/Validate endpoint. The first shows a successful validation with price details. The second and third show 400 Bad Request errors for insufficient quantity and unavailable automatic renewal, respectively.

```javascript
{
    "message": "Validation Passed. You can now use /v2/Orders endpoint to create an order.",
    "statusCode": "OK",
    "requestDetails": {
        "userId": "00000000-0000-0000-0000-000000000000",
        "endpoint": "/v2/Orders/Validate",
        "date": "2021-11-07T15:01:06.776251Z",
        "timestamp": 1636297266,
        "userAgent": "PostmanRuntime/7.28.4",
        "clientIp": "::1"
    },
    "data": {
        "price": {
            "unitPrice": 55,
            "totalPrice": 55
        }
    }
}
```

```javascript
{
    "errors": [
        {
            "code": "InsufficientQuantityAvailable",
            "message": "Insufficient quantity available for this kind of products/locations."
        }
    ],
    "message": "Request failed.",
    "statusCode": "BadRequest",
    "requestDetails": {
        "userId": "00000000-0000-0000-0000-000000000000",
        "endpoint": "/v2/Orders/Validate",
        "date": "2021-11-07T15:02:02.753931Z",
        "timestamp": 1636297322,
        "userAgent": "PostmanRuntime/7.28.4",
        "clientIp": "::1"
    }
}
```

```javascript
{
    "errors": [
        {
            "code": "UnavailableAutomaticRenew",
            "message": "With this payment method it's not possible to enable autorenew."
        }
    ],
    "message": "Request failed.",
    "statusCode": "BadRequest",
    "requestDetails": {
        "userId": "00000000-0000-0000-0000-000000000000",
        "endpoint": "/v2/Orders/Validate",
        "date": "2021-11-07T15:04:15.939415Z",
        "timestamp": 1636297455,
        "userAgent": "PostmanRuntime/7.28.4",
        "clientIp": "::1"
    }
}
```

--------------------------------

### JWT Authentication with Authorization Header

Source: https://docs.hypeproxy.io/basic-concepts/authentication.md

Use this HTTP request to authenticate with a JWT token via the Authorization header. The Profile endpoint is only an example; the same header works on every endpoint.

```http
GET /v2/Profile HTTP/1.1
Host: api.hypeproxy.io
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
```

--------------------------------

### hproxy-ctl help output

Source: https://docs.hypeproxy.io/command-line-interface-cli.md

Output of running `hproxy-ctl` without arguments. Shows the banner, a short description, and the available flags and options, including `--no-banner` to disable the banner and `-c, --config <config>` to specify a configuration file.

```text

██╗  ██╗██╗   ██╗██████╗ ███████╗██████╗ ██████╗  ██████╗ ██╗  ██╗██╗   ██╗
██║  ██║╚██╗ ██╔╝██╔══██╗██╔════╝██╔══██╗██╔══██╗██╔═══██╗╚██╗██╔╝╚██╗ ██╔╝
███████║ ╚████╔╝ ██████╔╝█████╗  ██████╔╝██████╔╝██║   ██║ ╚███╔╝  ╚████╔╝
██╔══██║  ╚██╔╝  ██╔═══╝ ██╔══╝  ██╔═══╝ ██╔══██╗██║   ██║ ██╔██╗   ╚██╔╝
██║  ██║   ██║   ██║     ███████╗██║     ██║  ██║╚██████╔╝██╔╝ ██╗   ██║
╚═╝  ╚═╝   ╚═╝   ╚═╝     ╚══════╝╚═╝     ╚═╝  ╚═╝ ╚═════╝ ╚═╝  ╚═╝   ╚═╝

Use HypeProxy.io API with command line.
Written in Rust. https://github.com/hypeproxy/hpro-ctl

FLAGS:
    -h, --help         Prints help information
        --no-banner    Disable showing the banner on start
    -V, --version      Prints version information

OPTIONS:
    -c, --config <config>    Specify the configuration file

```

--------------------------------

### Connect to HypeProxy.io API Base URLs

Source: https://docs.hypeproxy.io/basic-concepts/getting-started.md

Use these base URLs to interact with the v2 API. The first URL is recommended for standard use.

```bash
curl "https://api.hypeproxy.io/v2/"
curl "https://hypeproxy-api.azurewebsites.net/v2/"
```

--------------------------------

### Order endpoints: /v2/Orders/Create and /v2/Orders/Validate

Source: https://docs.hypeproxy.io/api/order-process-1.md

Lists the two endpoints used in the order process. The first validates the order, the second creates it. Both accept the same JSON model.

```text
/v2/Orders/Create
/v2/Orders/Validate
```

--------------------------------

### POST /v2/Authentication/SignIn

Source: https://docs.hypeproxy.io/basic-concepts/authentication.md

Authenticates a user and returns a JWT token valid for 7 days.

```APIDOC
## POST /v2/Authentication/SignIn

### Description
Authenticates a user and returns a JWT token valid for 7 days.

### Method
POST

### Endpoint
https://api.hypeproxy/io/v2/Authentication/SignIn

### Parameters
#### Request Body
- **email** (String) - Required - User email
- **password** (String) - Required - User password
- **otpCode** (String) - Optional - User OTP, if you enabled 2FA

### Request Example
{
  "email": "user@example.com",
  "password": "yourpassword",
  "otpCode": "123456"
}

### Response
#### Success Response (200)
Returns the JWT token as a plain string.

#### Response Example
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

#### Error Response (400) - User doesn't exist
{
  "errors": "This user doesn't exists.",
  "message": "Request failed.",
  "statusCode": "BadRequest",
  "requestDetails": {
    "userId": "00000000-0000-0000-0000-000000000000",
    "endpoint": "/v2/Authentication/SignIn",
    "date": "2021-11-08T12:16:20.6210678Z",
    "timestamp": 1636373780,
    "userAgent": "PostmanRuntime/7.28.4",
    "clientIp": "::1"
  }
}

#### Error Response (400) - Incorrect password
{
  "message": "Incorrect password.",
  "statusCode": "Forbidden",
  "requestDetails": {
    "userId": "00000000-0000-0000-0000-000000000000",
    "endpoint": "/v2/Authentication/SignIn",
    "date": "2021-11-08T12:18:18.1897927Z",
    "timestamp": 1636373898,
    "userAgent": "PostmanRuntime/7.28.4",
    "clientIp": "::1"
  }
}
```

--------------------------------

### POST /v2/Orders/Create

Source: https://docs.hypeproxy.io/api/order-process-1.md

Creates an order after validation. This is the second step in the order process.

```APIDOC
## POST /v2/Orders/Create

### Description
Creates an order after validation. This is the second step in the order process.

### Method
POST

### Endpoint
/v2/Orders/Create

### Parameters
#### Request Body
- **productId** (string) - Required - The ID of the product to order.
- **locationId** (string) - Required - The ID of the location where the order is placed.
- **paymentMethod** (string) - Required - The payment method to use (e.g., CreditCard, Cryptocurrencies).
- **billingPeriod** (string) - Required - The billing period for the order (e.g., Monthly, Weekly, Yearly).
- **quantity** (integer) - Required - The number of products to order.
- **isAutoRenewed** (boolean) - Required - Whether the order should be automatically renewed.
- **couponCode** (string) - Optional - A discount coupon code.

### Request Example
{
    "productId": "7d8f2363-2fc9-47af-aae2-c22043af12ed",
    "locationId": "d6e32771-4733-4de5-9b95-d0ef1b30f00c",
    "billingPeriod": "Monthly",
    "paymentMethod": "CreditCard",
    "quantity": 1,
    "isAutoRenewed": true
}
```

--------------------------------

### Query Parameter Authentication with apikey

Source: https://docs.hypeproxy.io/basic-concepts/authentication.md

Use this curl command to authenticate by passing the JWT token as a query parameter. This is for users who cannot set HTTP headers.

```bash
curl "https://api.hypeproxy.io/v2/Profile?apikey=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
```

--------------------------------

### 200 OK: Return JWT Token

Source: https://docs.hypeproxy.io/basic-concepts/authentication.md

Successful sign-in response returning the JWT token, valid for 7 days.

```javascript
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
```

--------------------------------

### POST /v2/Renews/{productDetailsId}

Source: https://docs.hypeproxy.io/api/ip-rotation.md

Sets the IP renew delay for a specific product.

```APIDOC
## POST /v2/Renews/{productDetailsId}

### Description
Define the delay of renew for a specific product. The minimum renew is 1 minute.

### Method
POST

### Endpoint
/v2/Renews/{productDetailsId}

### Parameters
#### Path Parameters
- **productDetailsId** (string) - Required - The identifier of the product details.

```

--------------------------------

### 400: Bad Request User doesn't exists.

Source: https://docs.hypeproxy.io/basic-concepts/authentication.md

Error response when the user does not exist. The statusCode is BadRequest and the message indicates the user doesn't exist.

```javascript
{
    "errors": "This user doesn't exists.",
    "message": "Request failed.",
    "statusCode": "BadRequest",
    "requestDetails": {
        "userId": "00000000-0000-0000-0000-000000000000",
        "endpoint": "/v2/Authentication/SignIn",
        "date": "2021-11-08T12:16:20.6210678Z",
        "timestamp": 1636373780,
        "userAgent": "PostmanRuntime/7.28.4",
        "clientIp": "::1"
    }
}
```

--------------------------------

### POST /v2/Orders/Validate

Source: https://docs.hypeproxy.io/api/order-process-1.md

Validates an order according to the defined model. This is the first step in the order process.

```APIDOC
## POST /v2/Orders/Validate

### Description
Validates an order according to the defined model. This is the first step in the order process.

### Method
POST

### Endpoint
/v2/Orders/Validate

### Parameters
#### Request Body
- **productId** (string) - Required - The ID of the product to order.
- **locationId** (string) - Required - The ID of the location where the order is placed.
- **paymentMethod** (string) - Required - The payment method to use (e.g., CreditCard, Cryptocurrencies).
- **billingPeriod** (string) - Required - The billing period for the order (e.g., Monthly, Weekly, Yearly).
- **quantity** (integer) - Required - The number of products to order.
- **isAutoRenewed** (boolean) - Required - Whether the order should be automatically renewed.
- **couponCode** (string) - Optional - A discount coupon code.

### Request Example
{
    "productId": "7d8f2363-2fc9-47af-aae2-c22043af12ed",
    "locationId": "d6e32771-4733-4de5-9b95-d0ef1b30f00c",
    "billingPeriod": "Monthly",
    "paymentMethod": "CreditCard",
    "quantity": 1,
    "isAutoRenewed": true
}
```

--------------------------------

### Perform API Health Check

Source: https://docs.hypeproxy.io/basic-concepts/getting-started.md

Use the health check endpoint to verify API availability and detect if any down bays are present.

```bash
curl "https://api.hypeproxy.io/health"
```

--------------------------------

### Renew IP Response (200 OK)

Source: https://docs.hypeproxy.io/api/v1-api-documentation.md

Response returned by the Renew IP endpoint when the renewal request is accepted. The operation is asynchronous and takes about 8 seconds in the background, requiring a USB modem reboot. Even if the renewal fails, the API always returns this same response.

```javascript
"IP Renew done."
```

--------------------------------

### DELETE /v2/Renews/{productDetailsId}

Source: https://docs.hypeproxy.io/api/ip-rotation.md

Removes the IP renew feature for a specific product.

```APIDOC
## DELETE /v2/Renews/{productDetailsId}

### Description
Remove the IP renew feature for a specific product.

### Method
DELETE

### Endpoint
/v2/Renews/{productDetailsId}

### Parameters
#### Path Parameters
- **productDetailsId** (string) - Required - The identifier of the product details.

```

--------------------------------

### 400: Bad Request Incorrect password.

Source: https://docs.hypeproxy.io/basic-concepts/authentication.md

Error response when the password is incorrect. The statusCode is Forbidden and the message indicates the password is incorrect.

```javascript
{
    "message": "Incorrect password.",
    "statusCode": "Forbidden",
    "requestDetails": {
        "userId": "00000000-0000-0000-0000-000000000000",
        "endpoint": "/v2/Authentication/SignIn",
        "date": "2021-11-08T12:18:18.1897927Z",
        "timestamp": 1636373898,
        "userAgent": "PostmanRuntime/7.28.4",
        "clientIp": "::1"
    }
}
```
Tokens:
Raw