Components

Schemas ​

OrderProxyRequest ​

  • object
    Properties:
    • filtersobject | null

      Proxy order filters

      Properties:
      • geo_countryarray

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

        Items:
        • string
          Example: 
          "RU"
      • geo_regionarray

        Proxy's region of origin within a country

        Items:
        • string
          Example: 
          "Tatarstan Republic"
      • geo_cityarray

        Proxy's city of origin within a region

        Items:
        • string
          Example: 
          "Kazan"
      • geo_operatorarray

        Proxy operator

        Items:
        • string
          Example: 
          "mts"
      • typearray

        Proxy type

        Items:
        • string
          Example: 
          "shared"
          enum: private, shared
      • protocolarray

        Proxy protocol (http or socks5)

        Items:
        • string
          Example: 
          "http"
          enum: http, socks5
    • periodintegerRequired

      Proxy's duration period (in days)

      Example: 
      1
    • pricestringRequired

      Proxy's purchase price (in USD)

      Example: 
      "1.23"

UpdateProxyRequest ​

  • object
    Properties:
    • rotate_ip_freqinteger

      IP address rotation frequency in minutes (0 - disabled)

      Example: 
      5
      Maximum: 60
      Minimum: 0

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

ErrorResponse ​

  • object
    Properties:
    • messagestringRequired

      Error message

    • errorsobject | null

      Input validation errors

FiltersResponse ​

  • object
    Properties:
    • geo_countryarray

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

      Items:
      • string
        Example: 
        "RU"
    • geo_regionarray

      Region name where server is located

      Items:
      • string
        Example: 
        "Tatarstan Republic"
    • geo_cityarray

      City name where proxy server is located.

      Items:
      • object
        Properties:
        • geo_citystring

          City name where proxy server is located.

          Example: 
          "Moscow"
        • geo_countrystring

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

          Example: 
          "RU"
    • geo_operatorarray

      Name of the operator of the proxy server.

      Items:
      • object
        Properties:
        • geo_operatorstring

          Name of the operator of the proxy server.

          Example: 
          "mts"
        • geo_countrystring

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

          Example: 
          "RU"
    • typearray

      Proxy type

      Items:
      • string
        Example: 
        "shared"
        enum: private, shared
    • protocolarray

      Proxy protocol

      Items:
      • string
        Example: 
        "http"
        enum: http, socks5