Solicitações gerais

Quatro pontos de extremidade para leitura de informações de toda a conta. Todos usam o URL básico/client-api/v1/<apiKey>/. Todos os retornos200 OK comsuccess: true no sucesso - consulte Possíveis erros para modos de falha.

Ponto final	Método	Devoluções
Equilíbrio	`GET /get/balance`	Saldo da conta corrente.
Lista de proxies comprados	`GET /get/proxies`	Todos os proxies que você possui, agrupados por tipo.
Períodos de aluguel disponíveis	`GET /get/days`	Válido`rentPeriodDays` valores para compra ou renovação.
Países disponíveis	`GET /get/countries`	Países disponíveis para comprar proxies.

Equilíbrio

GET/pt-BR/client-api/v1/<apiKey>/get/balance

Exemplo de solicitação

curl https://proxy-ipv4.com/client-api/v1/API_KEY/get/balance

Exemplo de resposta

{
  "success": true,
  "user": "[email protected]",
  "balance": 13.09,
  "currency": "USD"
}

Campos de resposta

Campo	Tipo	Descrição
`success`	booleano	Status da operação.
`user`	string	E-mail da conta.
`balance`	número	Saldo atual em`currency`.
`currency`	string	Código ISO da moeda.

Lista de proxies comprados

GET/pt-BR/client-api/v1/<apiKey>/get/proxies

Retorna todos os proxies ativos na conta, agrupados por tipo de proxy.

Exemplo de solicitação

curl https://proxy-ipv4.com/client-api/v1/$KEY/get/proxies

Exemplo de resposta

Alterne as guias para ver a forma por tipo de proxy. O wrapper de nível superior é o mesmo; os objetos proxy são diferentes.

{
      "success": true,
      "user": "[email protected]",
      "balance": 13.09,
      "currency": "USD",
      "countOfProxy": 6,
      "ipv4": [
        {
          "id": "id1",
          "ip": "185.81.112.215",
          "country": "GBR",
          "dateStart": "2022-08-29T14:55:38.293+00:00",
          "dateEnd":   "2022-08-30T23:59:38.293+00:00",
          "httpsPort": "49162",
          "socks5Port": "49163",
          "authInfo": { "login": "authLogin123", "password": "authPassword" }
        }
      ]
    }

{
      "success": true,
      "user": "[email protected]",
      "balance": 13.09,
      "currency": "USD",
      "countOfProxy": 6,
      "ipv6": [
        {
          "orderId": "orderId1",
          "ip": "2001:db8:abcd::1",
          "country": "GBR",
          "dateStart": "2022-08-29T14:55:38.293+00:00",
          "dateEnd":   "2022-08-30T23:59:38.293+00:00",
          "port": "49162",
          "protocol": "HTTP",
          "authInfo": { "login": "authLogin123", "password": "authPassword" }
        }
      ]
    }

{
      "success": true,
      "user": "[email protected]",
      "balance": 13.09,
      "currency": "USD",
      "countOfProxy": 6,
      "isp": [
        {
          "id": "id1",
          "ip": "185.81.112.215",
          "country": "GBR",
          "dateStart": "2022-08-29T14:55:38.293+00:00",
          "dateEnd":   "2022-08-30T23:59:38.293+00:00",
          "httpsPort": "49162",
          "socks5Port": "49163",
          "authInfo": { "login": "authLogin123", "password": "authPassword" }
        }
      ]
    }

{
      "success": true,
      "user": "[email protected]",
      "balance": 13.09,
      "currency": "USD",
      "countOfProxy": 6,
      "mobile": [
        {
          "id": "id1",
          "ip": "185.81.112.215",
          "country": "GBR",
          "dateStart": "2022-08-29T14:55:38.293+00:00",
          "dateEnd":   "2022-08-30T23:59:38.293+00:00",
          "httpsPort": "49162",
          "socks5Port": "49163",
          "authInfo": { "login": "authLogin123", "password": "authPassword" },
          "mobileOperator": "kyivstar",
          "rotationTime": 5,
          "rebootLink": "https://proxy-ipv4.com/link"
        }
      ]
    }

Campos de nível superior

Campo	Tipo	Descrição
`success`	booleano	Status da operação.
`user`	string	E-mail da conta.
`balance`	número	Saldo atual em`currency`.
`currency`	string	Código ISO da moeda.
`countOfProxy`	número	Total de proxies em todos os tipos.
`ipv4`	matriz	Lista de proxies IPv4. Vazia se você não tiver nenhum.
`ipv6`	matriz	Lista de proxies IPv6. Vazia se você não tiver nenhum.
`isp`	matriz	Lista de proxies de ISP. Vazia se você não tiver nenhum.
`mobile`	matriz	Lista de proxies móveis. Vazia se você não tiver nenhum.

Campos do objeto proxy

Alguns campos aparecem apenas para determinados tipos de proxy. A coluna "Presente em" é a fonte da verdade para a variação por tipo.

Campo	Tipo	Presente em	Descrição
`id`	string	IPv4, ISP, Móvel	ID do proxy. Use-o ao estender o proxy.
`orderId`	string	Somente IPv6	ID do pedido. O IPv6 só pode ser estendido por pedido inteiro, não por proxy - use esse ID para operações de extensão.
`ip`	string	Todos	O endereço IP.
`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` /`socks5Port`	string	IPv4, ISP, Móvel	Portas para HTTP/HTTPS e SOCKS5.
`port`	string	Somente IPv6	Porta única.
`protocol`	string	Somente IPv6	Sempre`HTTP` para IPv6.
`authInfo`	objeto	Todos	`{ login, password }` para autenticação de proxy.
`mobileOperator`	string	Somente celular	Etiqueta da operadora de celular.
`rotationTime`	número	Somente celular	Intervalo de rotação de IP em minutos.`0` significa rotação somente por link.
`rebootLink`	string	Somente celular	URL para acionar manualmente a rotação.

Períodos de aluguel disponíveis

GET/pt-BR/client-api/v1/<apiKey>/get/days?proxyType=<type>

Retorna o valor válido derentPeriodDays valores que você pode usar ao comprar ou renovar proxies. Os períodos disponíveis podem variar de acordo com o tipo de proxy.

Parâmetro de consulta

Nome	Tipo	Necessário	Descrição
`proxyType`	string	sim	Um de:`ipv4`,`ipv6`,`isp`,`mobile`.

Exemplo de solicitação

curl "https://proxy-ipv4.com/client-api/v1/$KEY/get/days?proxyType=ipv4"

Exemplo de resposta

{
  "success": true,
  "user": "[email protected]",
  "balance": 13.09,
  "currency": "USD",
  "days": [1, 7, 14, 30, 60, 90]
}

Campos de resposta

Campo	Tipo	Descrição
`success`	booleano	Status da operação.
`user`	string	E-mail da conta.
`balance`	número	Saldo atual em`currency`.
`currency`	string	Código ISO da moeda.
`days`	matriz de números	Valores válidos do período de aluguel para a solicitação`proxyType`.

Países disponíveis

GET/pt-BR/client-api/v1/<apiKey>/get/countries?proxyType=<type>

Retorna os países nos quais você pode comprar proxies. Os países disponíveis podem variar de acordo com o tipo de proxy.

Parâmetro de consulta

Nome	Tipo	Necessário	Descrição
`proxyType`	string	sim	Um de:`ipv4`,`ipv6`,`isp`,`mobile`.

Exemplo de solicitação

curl "https://proxy-ipv4.com/client-api/v1/$KEY/get/countries?proxyType=ipv4"

Exemplo de resposta

{
  "success": true,
  "user": "[email protected]",
  "balance": 13.09,
  "currency": "USD",
  "countries": [
    { "name": "ENGLAND", "alpha3code": "GBR" },
    { "name": "USA",     "alpha3code": "USA" },
    { "name": "FRANCE",  "alpha3code": "FRA" }
  ]
}

Campos de resposta

Campo	Tipo	Descrição
`success`	booleano	Status da operação.
`user`	string	E-mail da conta.
`balance`	número	Saldo atual em`currency`.
`currency`	string	Código ISO da moeda.
`countries`	matriz	Países disponíveis para a solicitação`proxyType`.
`countries[].name`	string	Nome do país.
`countries[].alpha3code`	string	Código ISO 3166-1 alfa-3. Use esse valor ao fazer um pedido.

Solicitações gerais

Equilíbrio

Exemplo de solicitação

Exemplo de resposta

Campos de resposta

Lista de proxies comprados

Exemplo de solicitação

Exemplo de resposta

Campos de nível superior

Campos do objeto proxy

Períodos de aluguel disponíveis

Parâmetro de consulta

Exemplo de solicitação

Exemplo de resposta

Campos de resposta

Países disponíveis

Parâmetro de consulta

Exemplo de solicitação

Exemplo de resposta

Campos de resposta

On this page