Obtener direcciones IP

Enumere sus direcciones IP activas. Mismo recurso (/ipAddress), tres modos de llamada en función de lo que necesites.

Modo	Método	Utilizar cuando
Obtener todo	GET	Usted quiere cada IP a través de todos los tipos de proxy en una llamada.
Filtrar por tipo de proxy	GET	Sólo necesita uno de`IPv4`,`IPv6`,`MOBILE`o`ISP`.
Paginado por tipo de proxy	POST	Tienes muchas IPs de un mismo tipo y quieres buscar entre ellas.

Común a todos los modos

URL base:/client/api/v1/{apiKey}/ipAddress

Nombre	Tipo	Descripción
apiKey*	Cadena	Su clave personal de API.

Para conocer la forma de los campos por IP, consulteCampos de respuesta. En caso de error, consulteRespuesta de error.

Obtener todo

GET/es-ES/client/api/v1/{apiKey}/ipAddress

Sin parámetros de consulta. La respuesta agrupa IPs bajo las cuatro claves proxyType (matrices vacías si no tiene ninguna de un tipo dado).

curl https://youproxy.io/client/api/v1/{apiKey}/ipAddress

{
  "success": true,
  "data": {
    "IPv4": [
      {
        "orderId": "1112223334283d122",
        "ipAddresses": [
          {
            "ipAddressId": "1111111111111111",
            "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 }
          }
        ]
      }
    ],
    "IPv6": [
      {
        "orderId": "45654645634283d122",
        "ipAddresses": [
          {
            "ipAddressId": "2222222222222222",
            "ipAddressIp": "2001:db8:abcd::1",
            "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 }
          }
        ]
      }
    ],
    "MOBILE": [
      {
        "orderId": "65757867887978122",
        "ipAddresses": [
          {
            "ipAddressId":    "3333333333333333",
            "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 }
          }
        ]
      }
    ],
    "ISP": [
      {
        "orderId": "11122233342835555",
        "ipAddresses": [
          {
            "ipAddressId": "4444444444444444",
            "ipAddressIp": "203.0.113.42",
            "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 }
          }
        ]
      }
    ]
  }
}

Filtrar por tipo de proxy

GET/es-ES/client/api/v1/{apiKey}/ipAddress?proxyType={type}

Nombre	Tipo	Descripción
apiKey*	Cadena	Uno de: IPv4, IPv6, MÓVIL, ISP

curl https://youproxy.io/client/api/v1/{apiKey}/ipAddress?proxyType=IPv4

Cambia de pestaña para ver la respuesta de cadaproxyType

{
      "success": true,
      "data": {
        "IPv4": [
          {
            "orderId": "1112223334283d122",
            "ipAddresses": [
              {
                "ipAddressId": "1111111111111111",
                "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 }
              }
            ]
          }
        ]
      }
    }

{
      "success": true,
      "data": {
        "IPv6": [
          {
            "orderId": "45654645634283d122",
            "ipAddresses": [
              {
                "ipAddressId": "2222222222222222",
                "ipAddressIp": "2001:db8:abcd::1",
                "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 }
              }
            ]
          }
        ]
      }
    }

{
      "success": true,
      "data": {
        "MOBILE": [
          {
            "orderId": "65757867887978122",
            "ipAddresses": [
              {
                "ipAddressId":    "3333333333333333",
                "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 }
              }
            ]
          }
        ]
      }
    }

{
      "success": true,
      "data": {
        "ISP": [
          {
            "orderId": "11122233342835555",
            "ipAddresses": [
              {
                "ipAddressId": "4444444444444444",
                "ipAddressIp": "203.0.113.42",
                "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 }
              }
            ]
          }
        ]
      }
    }

Paginado por tipo de proxy

POST/es-ES/client/api/v1/{apiKey}/ipAddress?proxyType={type}

Verificar con backend: en los documentos actualesproxyType aparece tanto en la cadena de consulta como en el cuerpo de la petición. Debe estar en un solo lugar, probablemente en la consulta (coincide con la versión GET).

Cuerpo	Tipo	Descripción
página*	número	Índice de páginas, empezando por 0.
talla*	número	Número de IP por página.

curl -X POST "https://youproxy.io/client/api/v1/$KEY/ipAddress?proxyType=IPv4" \
  -H "Content-Type: application/json" \
  -d '{ "page": 0, "size": 50 }'

La respuesta es planacontent (no agrupados por orden) más metadatos de paginación. Cambie de pestaña para ver la forma de respuesta por tipo.

{
      "success": true,
      "data": {
        "totalElements": 1,
        "totalPages": 1,
        "content": [
          {
            "ipAddressId": "1111111111111111",
            "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
    }

{
      "success": true,
      "data": {
        "totalElements": 1,
        "totalPages": 1,
        "content": [
          {
            "ipAddressId": "2222222222222222",
            "ipAddressIp": "2001:db8:abcd::1",
            "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
    }

{
      "success": true,
      "data": {
        "totalElements": 1,
        "totalPages": 1,
        "content": [
          {
            "ipAddressId":    "3333333333333333",
            "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
    }

{
      "success": true,
      "data": {
        "totalElements": 1,
        "totalPages": 1,
        "content": [
          {
            "ipAddressId": "4444444444444444",
            "ipAddressIp": "203.0.113.42",
            "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
    }

Campos de paginación

Campo	Tipo	Descripción
totalElementos	número	Total de IPs que coinciden con el filtro.
totalPáginas	número	Número total de páginas del documento solicitado`size`.
contenido	matriz	IPs en esta página.

Campos de respuesta (objeto IP)

Forma de cada objeto de dirección IP - igual en los tres modos. Algunos campos sólo aparecen para determinados tipos de proxy.

Campo	Tipo	Presente en	Descripción
`ipAddressId`	cadena	Todos	ID de IP único. Utilícelo en llamadas de ampliación/autoampliación.
`ipAddressIp`	cadena	Todos	La dirección IP.
`orderId`	cadena	Todos	Orden a la que pertenece esta IP.
`country`	cadena	Todos	Código de país ISO 3166-1 alfa-3.
`dateStart` /`dateEnd`	cadena	Todos	Marcas de tiempo ISO 8601 para la ventana de alquiler.
`httpsPort`	cadena	`IPv4` `MOBILE` `ISP`	Puerto para conexiones HTTP/HTTPS.
`socks5Port`	cadena	`IPv4` `MOBILE` `ISP`	Puerto para conexiones SOCKS5.
`port`	cadena	`IPv6 only`	Puerto único. IPv6 sólo admite HTTP.
`protocol`	cadena	`IPv6 only`	Siempre HTTP para IPv6.
`mobileOperator`	cadena	`MOBILE only`	Etiqueta de operador, por ejemplo`kyivstar`.
`rotationTime`	número	`MOBILE only`	Intervalo de rotación IP (unidades TBD - verificar).
`rebootLink`	cadena	`MOBILE only`	URL para activar manualmente la rotación de IP.
`comment`	cadena \| null	Todos	Comentario del usuario para esta IP.
`authInfo`	objeto	Todos	`{ login, password }` para autenticación proxy.
`extendInfo`	objeto	Todos	`{ autoExtend, extendDays }` - auto-renewal config.

Envoltorio de respuesta paginada

Sólo el modo paginado envuelve los resultados en este sobre. Los otros dos modos devuelven una matriz plana de objetos IP.

Campo	Tipo	Descripción
`totalElements`	número	Total de IPs que coinciden con el filtro.
`totalPages`	número	Número total de páginas del documento solicitado`size`.
`content`	matriz	IPs en esta página.

Respuesta de error

Se devuelve cuando la solicitud no puede procesarse: clave de API no válida, parámetros malformados, etc. Misma forma independientemente del modo oproxyType.

{
  "success": false,
  "data": {},
  "error": {
    "code": 2,
    "message": "Error api key"
  }
}

Campo	Tipo	Descripción
éxito	booleano	Siempre`false` por error.
datos	objeto	Objeto vacío`{}` por error.
código.error	número	Código de error. Ver Posibles errores.
mensaje.error	cadena	Mensaje legible por humanos.