API¶

Awaiting¶

class proxycheck.Awaiting(key: Optional[str] = None)¶

await close() → None¶: Closes underlying TCP sessions.

ip(ip: str) → proxycheck.awaiting.ip.AwaitingIp ¶

Used to pull details on a IP.

Parameters: ip (str) –
Returns
Return type: AwaitingIp

IP¶

class proxycheck.awaiting.ip.AwaitingIp¶

await geological() → Tuple[Optional[float], Optional[float]]¶

Used to get the longitude & latitude.

Returns

str – latitude
str – longitude

await get(**kwargs) → proxycheck.model.IpModel ¶

Used to get details on a IP.

Parameters

vpn (bool, optional) – by default True
asn (bool, optional) – by default False
node (bool, optional) – by default False
time (bool, optional) – by default False
inf (bool, optional) – by default False
risk (bool, optional) – by default False
port (bool, optional) – by default False
seen (bool, optional) – by default False
days (int, optional) – by default None
tag (str, optional) – by default None
ver (datetime, optional) – by default None

Returns

Return type

IpModel

Raises

QueryFailed –
QueryDenied –
HTTPError – https://www.python-httpx.org/exceptions/#the-exception-hierarchy

await proxy() → Optional[bool]¶

Used to check if Ip address is proxy.

Returns: If proxy
Return type: bool

await risk() → Optional[int]¶

Used to get risk value.

Returns
Return type: int

Blocking¶

class proxycheck.Blocking(key: Optional[str] = None)¶

close() → None¶: Closes underlying TCP sessions.

ip(ip: str) → proxycheck.blocking.ip.BlockingIp ¶

Used to pull details on a IP.

Parameters: ip (str) –
Returns
Return type: BlockingIp

IP¶

class proxycheck.blocking.ip.BlockingIp¶

geological() → Tuple[Optional[float], Optional[float]]¶

Used to get the longitude & latitude.

Returns

str – latitude
str – longitude

get(**kwargs) → proxycheck.model.IpModel ¶

Used to get details on a IP.

Parameters

vpn (bool, optional) – by default True
asn (bool, optional) – by default False
node (bool, optional) – by default False
time (bool, optional) – by default False
inf (bool, optional) – by default False
risk (bool, optional) – by default False
port (bool, optional) – by default False
seen (bool, optional) – by default False
days (int, optional) – by default None
tag (str, optional) – by default None
ver (datetime, optional) – by default None

Returns

Return type

IpModel

Raises

QueryFailed –
QueryDenied –
HTTPError – https://www.python-httpx.org/exceptions/#the-exception-hierarchy

proxy() → Optional[bool]¶

Used to check if Ip address is proxy.

Returns: If proxy
Return type: bool

risk() → Optional[int]¶

Used to get risk value.

Returns
Return type: int