GET

getProxyById

proxy

Return proxy.

Description ​

Retrieve detailed information for a single proxy. This request could be used to obtain proxy ID, login, password, IP address, location, protocol (HTTP, SOCKS5, etc.), and other relevant metadata. It also includes information on proxy rotation and its expiration date.

Parameters ​

id Required
Location: path

Proxy ID. The response will contain data for the specified proxy, identified by its ID, which is generated by the OnlineProxy server upon purchase.

Scheme:

  • integer
    Example: 
    1
    Format: int64

Responses ​

200 ​

OK. A successful server response returns detailed information about the specified proxy.

Content

Content type:
  • Schema
  • 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

403 ​

Forbidden. API access denied. Please check your Account settings to ensure that API access is enabled and your IP address is listed in the Access IPs section. If the issue persists, please contact us.

Content

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

      Error message

    • errorsobject | null

      Input validation errors

404 ​

Not found. The action cannot be performed on a non-existing resource. Please check the proxy's ID.

Content

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

      Error message

    • errorsobject | null

      Input validation errors