get List the proxies available for purchase (matching the filtering criteria).
/api/client/v1/filters
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.
В:
query
Пример:
RU
Схема:
- array<string>Пример:
["RU"]
Items:- stringПример:
"RU"
geo_region[]
Parameter that filters the response data based on the proxy's region(-s) within a country. Multiple entries are allowed.
В:
query
Пример:
Tatarstan Republic
Схема:
- array<string>Пример:
["Tatarstan Republic"]
Items:- stringПример:
"Tatarstan Republic"
geo_city[]
Parameter that filters the response data based on the proxy's city(-es). Multiple entries are allowed.
В:
query
Пример:
Kazan
Схема:
- array<string>Пример:
["Kazan"]
Items:- stringПример:
"Kazan"
geo_operator[]
Parameter that filters the response data based on the proxy's operator. Multiple entries are allowed.
В:
query
Пример:
megafon
Схема:
- array<string>Пример:
["mts"]
Items:- stringПример:
"mts"
type[]
Parameter that filters the response data based on the proxy's type (private or shared). Multiple entries are allowed.
В:
query
Пример:
shared
Схема:
- array<string>Пример:
["shared"]
Items:- stringПример:
"shared"
Перечисление:private
shared
protocol[]
Parameter that filters the response data based on the protocol (http or socks5). Multiple entries are allowed.
В:
query
Пример:
http
Схема:
- array<string>Пример:
["http"]
Items:- stringПример:
"http"
Перечисление:http
socks5
Ответы
200
OK. Successful response. Returns a list of proxies available for purchase based on the specified criteria.
Тип содержимого:
application/json
- Schema
- Example
- objectFiltersResponseПример:
{"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"]}
Свойства:geo_country
array<string>The country of origin of the proxy server. Country codes are in ISO 3166-1 alpha-2 format.
Пример:["RU"]
Items:- stringПример:
"RU"
geo_region
array<string>Region name where server is locatedПример:["Tatarstan Republic"]
Items:- stringПример:
"Tatarstan Republic"
geo_city
arrayCity name where proxy server is located.Пример:[{"geo_city":"Moscow","geo_country":"RU"}]
Items:- objectПример:
{"geo_city":"Moscow","geo_country":"RU"}
geo_operator
arrayName of the operator of the proxy server.Пример:[{"geo_operator":"mts","geo_country":"RU"}]
Items:- objectПример:
{"geo_operator":"mts","geo_country":"RU"}
type
array<string>Proxy typeПример:["shared"]
Items:- stringПример:
"shared"
Перечисление:private
shared
protocol
array<string>Protocol typeПример:["http"]
Items:- stringПример:
"http"
Перечисление:http
socks5
401
Unauthorized. Missing or invalid authentication token, please check the Authorization header.
Тип содержимого:
application/json
- Schema
- Example
- objectErrorResponseПример:
{"message":"string","errors":{}}
Свойства:message
stringОбязательныйError messageПример:"string"
errors
object or nullInput validation errorsПример:{}
422
Unprocessable Entity. Invalid filter parameters. Please check the parameters you have specified and try again.
Тип содержимого:
application/json
- Schema
- Example
- objectErrorResponseПример:
{"message":"string","errors":{}}
Свойства:message
stringОбязательныйError messageПример:"string"
errors
object or nullInput validation errorsПример:{}