GET

getProxiesList

proxy

Return proxy list (active or all).

Description ​

Retrieve detailed information for all proxies associated with the current account. This request can be used to obtain relevant metadata for all purchased proxies. By specifying the expired parameter, you can include expired proxies in the response.

Parameters ​

expired
Location: query

Defines whether to include expired proxies in the response. This parameter allows you to filter proxies based on their expiration status, making it easier to manage active and expired proxies separately.

Scheme:

  • integer
    enum: 0, 1
    [object Object]: 0

Responses ​

200 ​

OK. A successful server response returns detailed information about all associated proxies (with or without expired ones based on parameter you've used).

Content

Content type:
  • Schema
  • array
    Items:
    • ProxyResource object
      Properties:
      • idinteger

        Order ID, generated by the OnlineProxy server upon purchasing the proxy.

        Example: 
        1
        Format: int64
      • loginstring | null

        Login, use it to connect to the proxy server.

        Maximum length: 255
      • passwordstring | null

        Password, use it to connect to the proxy server.

        Maximum length: 255
      • protocolstring

        The protocol type required to connect to the proxy server.

        enum: http, socks5
      • hoststring

        Host or IP address of a proxy server.

        Maximum length: 255
      • portinteger

        Port of a proxy server.

        Example: 
        8080
      • geo_countrystring

        The country of origin of the proxy server. Country codes are in ISO 3166-1 alpha-2 format.

        Example: 
        "RU"
      • geo_citystring | null

        City name where proxy server is located.

        Example: 
        "Moscow"
        Maximum length: 255
      • geo_operatorstring | null

        Name of the operator of the proxy server.

        Example: 
        "mts"
        Maximum length: 255
      • privateboolean

        Proxy type

      • rotate_ip_urlstring | null

        URL for IP address rotation

      • rotate_ip_freqinteger

        IP address rotation frequency in minutes (0 - disabled)

        Example: 
        5
        Maximum: 60
        Minimum: 0
      • start_atstring

        Order start datetime UTC ISO-8601

        Format: date-time
      • stop_atstring

        Order expire datetime UTC ISO-8601

        Format: date-time

401 ​

Unauthorized. Missing or invalid authentication token, please check the Authorization header.

Content

Content type:
  • Schema
  • ErrorResponse object
    Properties:
    • messagestringRequired

      Error message

    • errorsobject | null

      Input validation errors