Youproxy

Obter endereços IP

Liste seus endereços IP ativos. Mesmo recurso (/ipAddress), três modos de chamada, dependendo do que você precisa.

Modo

Método

Use quando

Obter tudo

OBTER

Você deseja todos os IPs de todos os tipos de proxy em uma única chamada.

Filtrar por tipo de proxy

OBTER

Você só precisa de um dosIPv4,IPv6,MOBILEouISP.

Paginado por tipo de proxy

POST

Você tem muitos IPs de um tipo e deseja percorrê-los.

Comum a todos os modos

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

Nome

Tipo

Descrição

apiKey*

Cordas

Sua chave de API pessoal.

Para obter informações sobre o formato do campo por IP, consulteCampos de resposta. Em qualquer erro, consulteResposta ao erro.

Obter tudo

GET/pt-BR/client/api/v1/{apiKey}/ipAddress

Nenhum parâmetro de consulta. A resposta agrupa IPs em todas as quatro chaves proxyType (matrizes vazias se você não tiver nenhum de um determinado tipo).

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/pt-BR/client/api/v1/{apiKey}/ipAddress?proxyType={type}

Nome

Tipo

Descrição

apiKey*

Cordas

Um de: IPv4, IPv6, MOBILE, ISP

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

Alterne as guias para ver a resposta para 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/pt-BR/client/api/v1/{apiKey}/ipAddress?proxyType={type}

Verificar com o backend: nos documentos atuaisproxyType aparece tanto na string de consulta quanto no corpo da solicitação. Ele deve estar em um único lugar, provavelmente na consulta (corresponde à versão GET).

Corpo

Tipo

Descrição

página*

número

Índice de páginas, a partir de 0.

tamanho*

número

Número de IPs 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 }'

A resposta é um planocontent (não agrupados por ordem) mais metadados de paginação. Alterne as guias para ver a forma de resposta 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 paginação

Campo

Tipo

Descrição

totalElements

número

Total de IPs que correspondem ao filtro.

totalPages

número

Contagem total de páginas para a solicitaçãosize.

conteúdo

matriz

IPs nesta página.

Campos de resposta (objeto IP)

Forma de cada objeto de endereço IP - a mesma em todos os três modos. Alguns campos aparecem apenas para determinados tipos de proxy.

Campo

Tipo

Presente em

Descrição

ipAddressId

string

Todos

ID de IP exclusivo. Use-o em chamadas de extensão/extensão automática.

ipAddressIp

string

Todos

O endereço IP.

orderId

string

Todos

Ordem à qual esse IP pertence.

country

string

Todos

Código de país ISO 3166-1 alfa-3.

dateStart /dateEnd

string

Todos

Carimbos de data e hora ISO 8601 para a janela de aluguel.

httpsPort

string

IPv4 MOBILE ISP

Porta para conexões HTTP/HTTPS.

socks5Port

string

IPv4 MOBILE ISP

Porta para conexões SOCKS5.

port

string

IPv6 only

Porta única. O IPv6 suporta apenas HTTP.

protocol

string

IPv6 only

Sempre HTTP para IPv6.

mobileOperator

string

MOBILE only

Etiqueta do operador, por exemplokyivstar.

rotationTime

número

MOBILE only

Intervalo de rotação de IP (unidades TBD - verificar).

rebootLink

string

MOBILE only

URL para acionar manualmente a rotação de IP.

comment

string | null

Todos

Comentário fornecido pelo usuário para este IP.

authInfo

objeto

Todos

{ login, password } para autenticação de proxy.

extendInfo

objeto

Todos

{ autoExtend, extendDays } - configuração de renovação automática.

Invólucro de resposta paginada

Somente o modo paginado agrupa os resultados nesse envelope. Os outros dois modos retornam uma matriz plana de objetos IP.

Campo

Tipo

Descrição

totalElements

número

Total de IPs que correspondem ao filtro.

totalPages

número

Contagem total de páginas para a solicitaçãosize.

content

matriz

IPs nesta página.

Resposta ao erro

Retornado quando a solicitação não pode ser processada - chave de API inválida, parâmetros malformados, etc. A mesma forma, independentemente do modo ouproxyType.

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

Campo

Tipo

Descrição

sucesso

booleano

Semprefalse por erro.

dados

objeto

Objeto vazio{} por erro.

error.code

número

Código de erro. Consulte Possíveis erros.

error.message

string

Mensagem legível por humanos.

Extensão automática por IDs de pedidos

Previous Page

Tipo de proxy

Next Page

On this page

Comum a todos os modos
Obter tudo
Filtrar por tipo de proxy
Paginado por tipo de proxy
Campos de paginação
Campos de resposta (objeto IP)
Invólucro de resposta paginada
Resposta ao erro