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

/api/client/v1/filters
sale
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[]

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.

In: query
Example: RU
Schema:
  • array<string>
    Example: ["RU"]
    Items:
    • string
      Example: "RU"
geo_region[]
Parameter that filters the response data based on the proxy's region(-s) within a country. Multiple entries are allowed.
In: query
Example: Tatarstan Republic
Schema:
  • array<string>
    Example: ["Tatarstan Republic"]
    Items:
    • string
      Example: "Tatarstan Republic"
geo_city[]
Parameter that filters the response data based on the proxy's city(-es). Multiple entries are allowed.
In: query
Example: Kazan
Schema:
  • array<string>
    Example: ["Kazan"]
    Items:
    • string
      Example: "Kazan"
geo_operator[]
Parameter that filters the response data based on the proxy's operator. Multiple entries are allowed.
In: query
Example: megafon
Schema:
  • array<string>
    Example: ["mts"]
    Items:
    • string
      Example: "mts"
type[]
Parameter that filters the response data based on the proxy's type (private or shared). Multiple entries are allowed.
In: query
Example: shared
Schema:
  • array<string>
    Example: ["shared"]
    Items:
    • string
      Example: "shared"
      Enum: private shared
protocol[]
Parameter that filters the response data based on the protocol (http or socks5). Multiple entries are allowed.
In: query
Example: http
Schema:
  • array<string>
    Example: ["http"]
    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 Type:
application/json
  • Schema
  • Example
  • object
    FiltersResponse
    Example: {"geo_country":["RU"],"geo_region":["Tatarstan Republic"],"geo_city":[{"geo_city":"Moscow","geo_country":"RU"}],"geo_operator":[{"geo_operator":"mts","geo_country":"RU"}],"type":["shared"],"protocol":["http"]}
    Properties:
    • geo_country
      array<string>

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

      Example: ["RU"]
      Items:
      • string
        Example: "RU"
    • geo_region
      array<string>
      Region name where server is located
      Example: ["Tatarstan Republic"]
      Items:
      • string
        Example: "Tatarstan Republic"
    • geo_city
      array
      City name where proxy server is located.
      Example: [{"geo_city":"Moscow","geo_country":"RU"}]
      Items:
      • object
        Example: {"geo_city":"Moscow","geo_country":"RU"}
    • geo_operator
      array
      Name of the operator of the proxy server.
      Example: [{"geo_operator":"mts","geo_country":"RU"}]
      Items:
      • object
        Example: {"geo_operator":"mts","geo_country":"RU"}
    • type
      array<string>
      Proxy type
      Example: ["shared"]
      Items:
      • string
        Example: "shared"
        Enum: private shared
    • protocol
      array<string>
      Protocol type
      Example: ["http"]
      Items:
      • string
        Example: "http"
        Enum: http socks5

401

Unauthorized. Missing or invalid authentication token, please check the Authorization header.
Content Type:
application/json
  • Schema
  • Example
  • object
    ErrorResponse
    Example: {"message":"string","errors":{}}
    Properties:
    • message
      string
      Required
      Error message
      Example: "string"
    • errors
      object or null
      Input validation errors
      Example: {}

422

Unprocessable Entity. Invalid filter parameters. Please check the parameters you have specified and try again.
Content Type:
application/json
  • Schema
  • Example
  • object
    ErrorResponse
    Example: {"message":"string","errors":{}}
    Properties:
    • message
      string
      Required
      Error message
      Example: "string"
    • errors
      object or null
      Input validation errors
      Example: {}