Peticiones generales

Cuatro puntos finales para leer información sobre la cuenta. Todos utilizan la URL base/client-api/v1/<apiKey>/. Todas las devoluciones200 OK consuccess: true en caso de éxito - véase Posibles errores para los modos de fallo.

Punto final	Método	Devuelve
Saldo	`GET /get/balance`	Balanza por cuenta corriente.
Lista de proxies comprados	`GET /get/proxies`	Cada proxy que posees, agrupado por tipo.
Periodos de alquiler disponibles	`GET /get/days`	Válido`rentPeriodDays` valores de compra o renovación.
Países disponibles	`GET /get/countries`	Países en los que se pueden comprar proxies.

Saldo

GET/es-ES/client-api/v1/<apiKey>/get/balance

Ejemplo de solicitud

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

Ejemplo de respuesta

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

Campos de respuesta

Campo	Tipo	Descripción
`success`	booleano	Estado de funcionamiento.
`user`	cadena	Correo electrónico de la cuenta.
`balance`	número	Saldo actual en`currency`.
`currency`	cadena	Código de moneda ISO.

Lista de proxies comprados

GET/es-ES/client-api/v1/<apiKey>/get/proxies

Devuelve todos los proxy activos en la cuenta, agrupados por tipo de proxy.

Ejemplo de solicitud

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

Ejemplo de respuesta

Cambie de pestaña para ver la forma por tipo de proxy. La envoltura de nivel superior es la misma; los objetos proxy difieren.

{
      "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 nivel superior

Campo	Tipo	Descripción
`success`	booleano	Estado de funcionamiento.
`user`	cadena	Correo electrónico de la cuenta.
`balance`	número	Saldo actual en`currency`.
`currency`	cadena	Código de moneda ISO.
`countOfProxy`	número	Total de proxies de todos los tipos.
`ipv4`	matriz	Lista de proxies IPv4. Vacía si no tiene ninguno.
`ipv6`	matriz	Lista de proxies IPv6. Vacía si no tiene ninguno.
`isp`	matriz	Lista de proxies ISP. Vacía si no tiene ninguno.
`mobile`	matriz	Lista de proxies móviles. Vacía si no tiene ninguno.

Campos del objeto proxy

Algunos campos sólo aparecen para determinados tipos de proxy. La columna "Presente en" es la fuente de verdad para la variación por tipo.

Campo	Tipo	Presente en	Descripción
`id`	cadena	IPv4, ISP, Móvil	ID del proxy. Utilícelo cuando amplíe el proxy.
`orderId`	cadena	Sólo IPv6	ID de pedido. IPv6 sólo puede ampliarse por orden completa, no por proxy - utilice este ID para las operaciones de ampliación.
`ip`	cadena	Todos	La dirección 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` /`socks5Port`	cadena	IPv4, ISP, Móvil	Puertos para HTTP/HTTPS y SOCKS5.
`port`	cadena	Sólo IPv6	Puerto único.
`protocol`	cadena	Sólo IPv6	Siempre`HTTP` para IPv6.
`authInfo`	objeto	Todos	`{ login, password }` para la autenticación proxy.
`mobileOperator`	cadena	Sólo móvil	Etiqueta de operador de telefonía móvil.
`rotationTime`	número	Sólo móvil	Intervalo de rotación de IP en minutos.`0` significa rotación sólo por enlace.
`rebootLink`	cadena	Sólo móvil	URL para activar manualmente la rotación.

Periodos de alquiler disponibles

GET/es-ES/client-api/v1/<apiKey>/get/days?proxyType=<type>

Devuelve elrentPeriodDays valores que puede utilizar al comprar o renovar proxies. Los periodos disponibles pueden variar según el tipo de proxy.

Parámetro de consulta

Nombre	Tipo	Requerido	Descripción
`proxyType`	cadena	sí	Uno de:`ipv4`,`ipv6`,`isp`,`mobile`.

Ejemplo de solicitud

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

Ejemplo de respuesta

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

Campos de respuesta

Campo	Tipo	Descripción
`success`	booleano	Estado de funcionamiento.
`user`	cadena	Correo electrónico de la cuenta.
`balance`	número	Saldo actual en`currency`.
`currency`	cadena	Código de moneda ISO.
`days`	matriz de números	Valores válidos del período de alquiler para el`proxyType`.

Países disponibles

GET/es-ES/client-api/v1/<apiKey>/get/countries?proxyType=<type>

Devuelve los países en los que puede comprar poderes. Los países disponibles pueden variar según el tipo de proxy.

Parámetro de consulta

Nombre	Tipo	Requerido	Descripción
`proxyType`	cadena	sí	Uno de:`ipv4`,`ipv6`,`isp`,`mobile`.

Ejemplo de solicitud

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

Ejemplo de respuesta

{
  "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 respuesta

Campo	Tipo	Descripción
`success`	booleano	Estado de funcionamiento.
`user`	cadena	Correo electrónico de la cuenta.
`balance`	número	Saldo actual en`currency`.
`currency`	cadena	Código de moneda ISO.
`countries`	matriz	Países disponibles para la solicitud`proxyType`.
`countries[].name`	cadena	Nombre del país.
`countries[].alpha3code`	cadena	Código ISO 3166-1 alfa-3. Utilice este valor al realizar un pedido.

Peticiones generales

Saldo

Ejemplo de solicitud

Ejemplo de respuesta

Campos de respuesta

Lista de proxies comprados

Ejemplo de solicitud

Ejemplo de respuesta

Campos de nivel superior

Campos del objeto proxy

Periodos de alquiler disponibles

Parámetro de consulta

Ejemplo de solicitud

Ejemplo de respuesta

Campos de respuesta

Países disponibles

Parámetro de consulta

Ejemplo de solicitud

Ejemplo de respuesta

Campos de respuesta

On this page