GET

getAvailableFilters

sale

List the proxies available for purchase (matching the filtering criteria).

Description ​

This request allows you to get a list of all available proxies that match the criteria. You can filter proxies by geo location, operator, type, and protocol using query parameters.

Parameters ​

geo_country[]
Location: query

Parameter that filters the response data based on the proxy’s country(-ies) of origin. Country codes should be in ISO 3166-1 alpha-2 format. Multiple entries are allowed.

Scheme:

  • array
    Items:
    • string
      Example: 
      "RU"
geo_region[]
Location: query

Parameter that filters the response data based on the proxy's region(-s) within a country. Multiple entries are allowed.

Scheme:

  • array
    Items:
    • string
      Example: 
      "Tatarstan Republic"
geo_city[]
Location: query

Parameter that filters the response data based on the proxy's city(-es). Multiple entries are allowed.

Scheme:

  • array
    Items:
    • string
      Example: 
      "Kazan"
geo_operator[]
Location: query

Parameter that filters the response data based on the proxy's operator. Multiple entries are allowed.

Scheme:

  • array
    Items:
    • string
      Example: 
      "mts"
type[]
Location: query

Parameter that filters the response data based on the proxy's type (private or shared). Multiple entries are allowed.

Scheme:

  • array
    Items:
    • string
      Example: 
      "shared"
      enum: private, shared
protocol[]
Location: query

Parameter that filters the response data based on the protocol (http or socks5). Multiple entries are allowed.

Scheme:

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

Responses ​

200 ​

OK. Successful response. Returns a list of proxies available for purchase based on the specified criteria.

Content

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

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

422 ​

Unprocessable Entity. Invalid filter parameters. Please check the parameters you have specified and try again.

Content

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

      Error message

    • errorsobject | null

      Input validation errors