Youproxy
  • Welcome
  • How to start
    • Authorization
    • Custom settings
    • Preparations to create an order
    • Extend
    • Possible mistakes
  • API reference
    • Proxy type
    • Balance
    • Country
    • Rent period
    • Mobile operator
    • Promo codes
    • Price calculation
      • Calculate an order
      • Extend by IPs
      • Extend by orders ID
    • Create an order
    • Extend
      • Extend by IP addresses
      • Extend by order IDs
    • Auto-extend
      • Auto-extend by IP addresses
      • Auto-extend by order IDs
    • Get IP addresses
      • Get all
      • Get all by proxy type
      • Get page of all by proxy type
    • Possible errors
Powered by GitBook
On this page
  • IPv4 type
  • Path parameters
  • Query parameters
  • Response
  • IPv6 type
  • Path parameters
  • Query parameters
  • Response
  • Mobile type
  • Path parameters
  • Query Parameters
  • Response
  • ISP type
  • Path parameters
  • Query parameters
  • Response
  1. API reference

Rent period

IPv4 type

The request allows to view rent period days for proxy type IPv4.

GET /client/api/v1/{apiKey}/rentPeriod?proxyType=IPv4

Path parameters

Name
Type
Description

apiKey*

String

Your personal API key.

Query parameters

Name
Type
Description

proxyType*

String

Proxy type IPv4.

Response

200: OK Success response
{
    "success": true,
    "rentPeriodDays": [
        30,
        60,
        90,
        180,
        360
    ],
    "error": null
}
Name
Listed data

rentPeriodDays

30, 60, 90, 180, 360

200: OK Error response
{
    "success": false,
    "rentPeriodDays": [],
    "error": {
        "code": 4,
        "message": "Incorrect proxy type"
    }
}

IPv6 type

The request allows to view rent period days for proxy type IPv6.

GET /client/api/v1/{apiKey}/rentPeriod?proxyType=IPv6

Path parameters

Name
Type
Description

apiKey*

String

Your personal API key.

Query parameters

Name
Type
Description

proxyType*

String

Proxy type IPv6.

Response

200: OK Success response
{
    "success": true,
    "rentPeriodDays": [
        90,
        180,
        360
    ],
    "error": null
}
Name
Listed data

rentPeriodDays

90, 180, 360

200: OK Error response
{
    "success": false,
    "rentPeriodDays": [],
    "error": {
        "code": 4,
        "message": "Incorrect proxy type"
    }
}

Mobile type

The request allows to view rent period days for proxy type MOBILE.

GET /client/api/v1/{apiKey}/rentPeriod?proxyType=MOBILE

Path parameters

Name
Type
Description

apiKey*

String

Your personal API key.

Query Parameters

Name
Type
Description

proxyType*

String

Proxy type MOBILE.

Response

200: OK Success response
{
    "success": true,
    "rentPeriodDays": [
        30,
        360
    ],
    "error": null
}
Name
Listed data

rentPeriodDays

30, 360

200: OK Error response
{
    "success": false,
    "rentPeriodDays": [],
    "error": {
        "code": 4,
        "message": "Incorrect proxy type"
    }
}

ISP type

The request allows to view rent period days for proxy type ISP.

GET /users/client/api/v1/{apiKey}/rentPeriod?proxyType=ISP

Path parameters

Name
Type
Description

apiKey*

String

Your personal API key.

Query parameters

Name
Type
Description

proxyType*

String

Proxy type ISP.

Response

200: OK Success response
{
    "success": true,
    "rentPeriodDays": [
        30,
        60,
        90,
        180,
        360
    ],
    "error": null
}
Name
Listed data

rentPeriodDays

30,

60,

90, 180, 360

200: OK Error response
{
    "success": false,
    "rentPeriodDays": [],
    "error": {
        "code": 4,
        "message": "Incorrect proxy type"
    }
}
PreviousCountryNextMobile operator

Last updated 1 month ago