Wrapper#

class aioproxyline.core.client.ProxyLine(api_key: str)[source]#

Bases: BaseAPIClient, ABC

ProxyLine API Wrapper

__init__(api_key: str)[source]#
async get_balance() → Balance[source]#

Get balance

Returns:

Account balance information

Return type:

Balance

async get_proxy_list(status: Optional[ProxyStatus] = None, proxy_type: Optional[ProxyType] = None, ip_version: Optional[ProxyProtocol] = None, country: Optional[str] = None, date_end_after: Optional[datetime] = None, date_end_before: Optional[datetime] = None, date_after: Optional[datetime] = None, date_before: Optional[datetime] = None, orders: Optional[Union[List[int], int]] = None, proxy_format: Optional[ProxyFormat] = None, limit: Optional[int] = 200, offset: Optional[int] = 0) → ProxyList[source]#

Get proxy list

Parameters:

  • status – Status

  • proxy_type – Type

  • ip_version – IP version

  • country – Country

  • date_after – Date after

  • date_before – Date before

  • date_end_after – Date end after

  • date_end_before – Date end before

  • orders – Orders

  • proxy_format – Format

  • limit – Limit

  • offset – Offset

Returns:

List of proxies

Return type:

ProxyList

async get_orders(date_after: Optional[datetime] = None, date_before: Optional[datetime] = None) → List[Order][source]#

Get Orders

Parameters:

  • date_after – Date after

  • date_before – Date before

Returns:

List of orders

Return type:

List[Order]

async renew_proxy(proxy: Union[List[int], int], period: int, coupon: Optional[str] = None) → List[ProxyInfo][source]#

Renew proxy

Parameters:

  • proxy – Proxy ID

  • period – Renew period

  • coupon – Coupon

Returns:

Proxy Information

Return type:

List[ProxyInfo]

async order_proxy(proxy_type: ProxyType, ip_version: ProxyProtocol, country: str, period: int, quantity: int, coupon: Optional[str] = None, ip_list: Optional[List[int]] = None) → List[ProxyInfo][source]#

Order proxy

Parameters:

  • quantity – Quantity

  • ip_list – IP List received from ips method

  • proxy_type – Proxy Type

  • ip_version – IP version

  • country – Country

  • period – Period

  • coupon – Coupon

Returns:

Proxy Information

Return type:

List[ProxyInfo]

async get_order_price(proxy_type: ProxyType, ip_version: ProxyProtocol, country: str, period: int, quantity: int, coupon: Optional[str] = None, ip_list: Optional[List[int]] = None) → OrderPrice[source]#

Get Proxy Order Price

Parameters:

  • quantity – Quantity

  • ip_list – IP List received from ips method

  • proxy_type – Proxy Type

  • ip_version – IP version

  • country – Country

  • period – Period

  • coupon – Coupon

Returns:

Order Price

Return type:

OrderPrice

async get_countries() → List[Countries][source]#

Get countries

Returns:

Countries info

Return type:

List[Countries]

async get_ips(proxy_type: ProxyType, ip_version: ProxyProtocol, country: str, city: Optional[str] = None) → List[IPs][source]#

Get IPs

Parameters:

  • city – City

  • proxy_type – Proxy Type

  • ip_version – IP version

  • country – Country

Returns:

List of IPs

Return type:

List[IPs]

async get_ips_count(proxy_type: ProxyType, ip_version: ProxyProtocol, country: str, city: Optional[str] = None) → IPsCount[source]#

Get amount of available ips

Parameters:

  • city – City

  • proxy_type – Proxy Type

  • ip_version – IP version

  • country – Country name

Returns:

IPs Count

Return type:

IPsCount