General requests

Four endpoints for reading account-wide information. All use base URL /client-api/v1/<apiKey>/. All return 200 OK with success: true on success — see Possible mistakes for failure modes.

Endpoint	Method	Returns
Balance	`GET /get/balance`	Current account balance.
List of bought proxies	`GET /get/proxies`	Every proxy you own, grouped by type.
Available rent periods	`GET /get/days`	Valid `rentPeriodDays` values for purchase or renewal.
Available countries	`GET /get/countries`	Countries available to buy proxies in.

Balance

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

Example request

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

Example response

{
  "success": true,
  "user": "client@gmail.com",
  "balance": 13.09,
  "currency": "USD"
}

Response fields

Field	Type	Description
`success`	boolean	Operation status.
`user`	string	Account email.
`balance`	number	Current balance in `currency`.
`currency`	string	ISO currency code.

List of bought proxies

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

Returns every active proxy on the account, grouped by proxy type.

Example request

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

Example response

Switch tabs to see the shape per proxy type. Top-level wrapper is the same; proxy objects differ.

{
      "success": true,
      "user": "client@gmail.com",
      "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": "client@gmail.com",
      "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": "client@gmail.com",
      "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": "client@gmail.com",
      "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"
        }
      ]
    }

Top-level fields

Field	Type	Description
`success`	boolean	Operation status.
`user`	string	Account email.
`balance`	number	Current balance in `currency`.
`currency`	string	ISO currency code.
`countOfProxy`	number	Total proxies across all types.
`ipv4`	array	List of IPv4 proxies. Empty if you have none.
`ipv6`	array	List of IPv6 proxies. Empty if you have none.
`isp`	array	List of ISP proxies. Empty if you have none.
`mobile`	array	List of Mobile proxies. Empty if you have none.

Proxy object fields

Some fields appear only for certain proxy types. The "Present in" column is the source of truth for per-type variation.

Field	Type	Present in	Description
`id`	string	IPv4, ISP, Mobile	Proxy ID. Use this when extending the proxy.
`orderId`	string	IPv6 only	Order ID. IPv6 can only be extended by whole order, not per-proxy — use this ID for extend operations.
`ip`	string	All	The IP address.
`country`	string	All	ISO 3166-1 alpha-3 country code.
`dateStart` / `dateEnd`	string	All	ISO 8601 timestamps for the rent window.
`httpsPort` / `socks5Port`	string	IPv4, ISP, Mobile	Ports for HTTP/HTTPS and SOCKS5.
`port`	string	IPv6 only	Single port.
`protocol`	string	IPv6 only	Always `HTTP` for IPv6.
`authInfo`	object	All	`{ login, password }` for proxy authentication.
`mobileOperator`	string	Mobile only	Mobile operator tag.
`rotationTime`	number	Mobile only	IP rotation interval in minutes. `0` means rotation by link only.
`rebootLink`	string	Mobile only	URL to manually trigger rotation.

Available rent periods

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

Returns the valid rentPeriodDays values you can use when buying or renewing proxies. Available periods can differ by proxy type.

Query parameter

Name	Type	Required	Description
`proxyType`	string	yes	One of: `ipv4`, `ipv6`, `isp`, `mobile`.

Example request

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

Example response

{
  "success": true,
  "user": "client@gmail.com",
  "balance": 13.09,
  "currency": "USD",
  "days": [1, 7, 14, 30, 60, 90]
}

Response fields

Field	Type	Description
`success`	boolean	Operation status.
`user`	string	Account email.
`balance`	number	Current balance in `currency`.
`currency`	string	ISO currency code.
`days`	array of numbers	Valid rent period values for the requested `proxyType`.

Available countries

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

Returns countries you can buy proxies in. Available countries can differ by proxy type.

Query parameter

Name	Type	Required	Description
`proxyType`	string	yes	One of: `ipv4`, `ipv6`, `isp`, `mobile`.

Example request

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

Example response

{
  "success": true,
  "user": "client@gmail.com",
  "balance": 13.09,
  "currency": "USD",
  "countries": [
    { "name": "ENGLAND", "alpha3code": "GBR" },
    { "name": "USA",     "alpha3code": "USA" },
    { "name": "FRANCE",  "alpha3code": "FRA" }
  ]
}

Response fields

Field	Type	Description
`success`	boolean	Operation status.
`user`	string	Account email.
`balance`	number	Current balance in `currency`.
`currency`	string	ISO currency code.
`countries`	array	Available countries for the requested `proxyType`.
`countries[].name`	string	Country name.
`countries[].alpha3code`	string	ISO 3166-1 alpha-3 code. Use this value when placing an order.

Balance

Example request

Example response

Response fields

List of bought proxies

Example request

Example response

Top-level fields

Proxy object fields

Available rent periods

Query parameter

Example request

Example response

Response fields

Available countries

Query parameter

Example request

Example response

Response fields

On this page