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
  • View all IP addresses with IPv4
  • Path parameters
  • Query parameters
  • Responce
  • View all IP addresses with IPv6
  • Path parameters
  • Query parameters
  • Responce
  • View all IP addresses with MOBILE
  • Path parameters
  • Query parameters
  • Responce
  • View all IP addresses with ISP
  • Path parameters
  • Query parameters
  • Responce
  1. API reference
  2. Get IP addresses

Get all by proxy type

View all IP addresses with IPv4

The request allows to view all IP addresses grouped by orders with selected proxy type IPv4.

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

Path parameters

Name
Type
Description

apiKey*

String

Your personal API key.

Query parameters

Name
Type
Description

proxyType*

String

Proxy type IPv4.

Responce

200: OK Success response
{
    "success": true,
    "data": {
        "IPv4": [
             {
                "orderId": "1112223334283d122",
                "ipAddresses": [
                        {
                            "ipAddressId": "1111111111111111111",
                            "ipAddressIp": "111.222.333.444",
                            "orderId": "1112223334283d122",
                            "country": "DEU",
                            "dateStart": "2023-10-25T12:17:54.249+00:00",
                            "dateEnd": "2023-11-24T23:59:54.249+00:00",
                            "httpsPort": "49112",
                            "socks5Port": "32456",
                            "comment": "your comment",
                            "authInfo": {
                                "login": "login4444",
                                "password": "password"
                            },
                            "extendInfo": {
                                "autoExtend": false,
                                "extendDays": 0
                            }
                        }
                    ]
                }
            ],
    },
    "error": null
}
200: OK Error response
   {
    "success": false,
    "data": {},
    "error": {
        "code": 4,
        "message": "Incorrect proxy type"
    }

View all IP addresses with IPv6

The request allows to view all IP addresses grouped by orders with selected proxy type IPv6.

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

Path parameters

Name
Type
Description

apiKey*

String

Your personal API key.

Query parameters

Name
Type
Description

proxyType*

String

Proxy type IPv6.

Responce

200: OK Success response
{
    "success": true,
    "data": {
        "IPv6": [
            {
                "orderId": "45654645634283d122",
                "ipAddresses": [
                        {
                            "ipAddressId": "22222222222222222",
                            "ipAddressIp": "111.222.333.444",
                            "orderId": "45654645634283d122",
                            "country": "DEU",
                            "dateStart": "2023-10-25T12:17:54.249+00:00",
                            "dateEnd": "2023-11-24T23:59:54.249+00:00",
                            "port": "10012",
                            "protocol":"HTTP",
                            "comment": null,
                            "authInfo": {
                                "login": "login4444",
                                "password": "password"
                            },
                            "extendInfo": {
                                "autoExtend": true,
                                "extendDays": 30
                            }
                        }
                    ]
                }
            ],
      },
    "error": null
}
200: OK Error response
   {
    "success": false,
    "data": {},
    "error": {
        "code": 4,
        "message": "Incorrect proxy type"
    }

View all IP addresses with MOBILE

The request allows to view all IP addresses grouped by orders with selected proxy type MOBILE.

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

Path parameters

Name
Type
Description

apiKey*

String

Your personal API key.

Query parameters

Name
Type
Description

proxyType*

String

Proxy type MOBILE.

Responce

200: OK Success response
{
    "success": true,
    "data": {
        "MOBILE": [
            {
                "orderId": "65757867887978122",
                "ipAddresses": [
                        {
                            "ipAddressId": "333333333333333333",
                            "ipAddressIp": "101.123.234.456",
                            "orderId": "65757867887978122",
                            "country": "GBR",
                            "dateStart": "2023-10-03T13:02:02.432+00:00",
                            "dateEnd": "2023-11-02T23:59:02.432+00:00",
                            "httpsPort": "42443",
                            "socks5Port": "52334",
                            "mobileOperator": "kyivstar",
                            "rotationTime": 5,
                            "rebootLink": "https://youproxy.io/link",
                            "comment": null,
                            "authInfo": {
                                "login": "login4444",
                                "password": "password"
                            },
                            "extendInfo": {
                                "autoExtend": false,
                                "extendDays": 0
                            }
                        }
                    ]
                }
            ]
      },
    "error": null
}
200: OK Error response
   {
    "success": false,
    "data": {},
    "error": {
        "code": 4,
        "message": "Incorrect proxy type"
    }

View all IP addresses with ISP

The request allows to view all IP addresses grouped by orders with selected proxy type ISP.

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

Path parameters

Name
Type
Description

apiKey*

String

Your personal API key.

Query parameters

Name
Type
Description

proxyType*

String

Proxy type ISP.

Responce

200: OK Success response
{
    "success": true,
    "data": {
             "ISP": [
             {
                "orderId": "11122233342835555",
                "ipAddresses": [
                        {
                            "ipAddressId": "444444444444444",
                            "ipAddressIp": "555.444.333.222",
                            "orderId": "11122233342835555",
                            "country": "DEU",
                            "dateStart": "2023-10-25T12:17:54.249+00:00",
                            "dateEnd": "2023-11-24T23:59:54.249+00:00",
                            "httpsPort": "49112",
                            "socks5Port": "32456",
                            "comment": "your comment",
                            "authInfo": {
                                "login": "login555",
                                "password": "password"
                            },
                            "extendInfo": {
                                "autoExtend": false,
                                "extendDays": 0
                            }
                        }
                    ]
                }
            ],
    },
    "error": null
}
200: OK Error response
   {
    "success": false,
    "data": {},
    "error": {
        "code": 4,
        "message": "Incorrect proxy type"
    }
PreviousGet allNextGet page of all by proxy type

Last updated 1 month ago